R David Murray
0e8168c9e5
#24216 : fix typo
2015-05-17 10:16:37 -04:00
Yury Selivanov
82796193f9
Issue 24191: Document BoundArguments.signature
2015-05-14 14:14:02 -04:00
R David Murray
2249d9f7d6
Make sentence correct English.
2015-05-14 08:50:38 -04:00
Raymond Hettinger
3afdb2870f
Fix mangled wording
2015-05-13 14:39:04 -07:00
Raymond Hettinger
a3780259e4
Issue #19934 : Document *None* as an acceptable input to Counter.most_common([n])
2015-05-13 02:47:57 -07:00
Benjamin Peterson
19a3f17cb3
use imperative
2015-05-12 19:15:53 -04:00
Berker Peksag
c2dd680115
Issue #23983 : Update the pty module example.
...
Changes:
* Fixed a ResourceWarning warning
* Used argparse instead of getopt
2015-05-12 17:25:06 +03:00
Yury Selivanov
d7e19bb566
docs/asyncio: Document new ensure_future() and deprecated async()
2015-05-11 16:33:41 -04:00
Yury Selivanov
7185461897
docs/asyncio: Document set_task_factory/get_task_factory
2015-05-11 16:28:27 -04:00
Andrew Svetlov
b79e01248d
Fix doc: asyncio.Semaphore.release() actually is a regular function, not coroutine
2015-05-08 14:13:41 +03:00
Benjamin Peterson
ad643b59ce
remove word we don't need
2015-05-06 21:29:14 -04:00
Zachary Ware
828946e561
Fix copy/paste errors.
...
Basically, s/thread/coroutine/.
2015-05-06 20:19:06 -05:00
Benjamin Peterson
ac87ed7e9f
update example, since python.org is HTTPS-only now ( closes #24118 )
2015-05-03 12:59:09 -04:00
R David Murray
4590c3d944
#24108 : Update fnmatch.translate example to show correct output.
...
Patch by Merlijn van Deen.
2015-05-02 15:08:22 -04:00
R David Murray
6d877ef026
#24081 : Remove obsolete caveat from import docs.
...
Per Eric Snow's research, this changed in Python 2.4 in changeset 331e60d8ce,
but these docs were not updated.
Patch by Peter Viktorin.
2015-05-02 14:57:54 -04:00
Vinay Sajip
bbd95a9361
Issue #24060 : Made logging.Formatter documentation a little clearer.
2015-05-02 09:46:05 +01:00
Berker Peksag
2034caa0c4
Issue #24062 : Fix os.stat links. Patch by July Tikhonov.
2015-04-27 13:53:28 +03:00
Berker Peksag
8c99a6d604
Issue #23356 : Simplify convert_arg_line_to_args example.
...
Patch by py.user.
2015-04-26 12:09:54 +03:00
Benjamin Peterson
d87dd434c0
fix relative link ( closes #24057 )
2015-04-25 14:15:16 -04:00
Andrew Kuchling
333518e01d
#15183 : clarify timeit documentation to say that setup statement isn't timed
2015-04-21 19:43:33 -04:00
Benjamin Peterson
6de708fd46
recommend requests library ( closes #23989 )
...
Patch from Van Lindberg
2015-04-20 18:18:14 -04:00
Benjamin Peterson
cdbe29902e
fix grammar
2015-04-19 23:14:37 -04:00
Berker Peksag
37de910b52
Mark TarInfo.frombuf() and TarInfo.fromtarfile() as classmethods.
2015-04-19 04:37:35 +03:00
Berker Peksag
e4dde50c78
Issue #15566 : Document encoding and errors parameters of TarInfo.frombuf().
...
Patch by Andy Holst.
2015-04-19 04:32:23 +03:00
Vinay Sajip
2d965c2555
Issue #23536 : Clarified scope of fileConfig()'s API.
2015-04-18 13:14:10 +01:00
Gregory P. Smith
23a6a0daa1
remove trailing space :)
2015-04-14 10:04:30 -07:00
Gregory P. Smith
f2a448a66b
issue22046: mention that zipfile can raise NotImplementedError on unsupported
...
compression algorithms.
2015-04-14 10:02:20 -07:00
Berker Peksag
4882cacab6
Issue #23943 : Fix typos. Patch by Piotr Kasprzyk.
2015-04-14 09:30:01 +03:00
Zachary Ware
ae9f0fede3
Issue #23730 : Document the return value of ZipFile.extract
...
Patch by Stéphane Wirtel.
2015-04-13 16:40:49 -05:00
Antoine Pitrou
97aa953550
Fix duplicate doc entry for SSLContext.get_ca_certs()
...
(closes #18147 )
2015-04-13 21:06:15 +02:00
Berker Peksag
9575e1891f
Issue #12955 : Change the urlopen() examples to use context managers where appropriate.
...
Patch by Martin Panter.
2015-04-12 13:52:49 +03:00
Antoine Pitrou
8ad751e024
Close #23904 : fix pathlib documentation misleadingly mentioning that bytes objects are accepted in the PurePath constructor
2015-04-12 00:08:02 +02:00
Benjamin Peterson
1c69c3e3d8
use imperative
2015-04-11 07:42:42 -04:00
Berker Peksag
eb7a97c48e
Issue #23025 : Add a mention of os.urandom to RAND_bytes and RAND_pseudo_bytes docs.
...
Patch by Alex Gaynor.
2015-04-10 16:19:13 +03:00
Tim Golden
fe5ac52c2b
Fix typo in telnet docs (reported by Keith Briggs)
2015-04-08 16:52:27 +01:00
Benjamin Peterson
6f362fa6c8
actually ssl3 is just completely broken
2015-04-08 11:11:00 -04:00
Berker Peksag
7ecfc82edb
Issue #23400 : Raise same exception on both Python 2 and 3 if sem_open is not available.
...
Patch by Davin Potts.
2015-04-08 17:56:30 +03:00
Tim Golden
42c235e833
Added missing right bracket (reported by Daryl Klakouski)
2015-04-06 11:04:49 +01:00
Victor Stinner
72dcb0a765
Issue #23219 : Update asyncio.wait_for() documentation
...
the wait is cancelled, the future *fut* is now also cancelled.
2015-04-03 17:08:19 +02:00
Benjamin Peterson
8218bd4caf
document what exactly str.splitlines() splits on ( closes #12855 )
...
Patch by Martin Panter.
2015-03-31 21:20:36 -04:00
Raymond Hettinger
c43a666ba2
Issue #23729 : Improve docs for ElementTree namespace parsing
2015-03-30 20:29:28 -07:00
Ezio Melotti
2e3998fae0
#11468 : improve unittest basic example. Initial patch by Florian Preinstorfer.
2015-03-24 12:42:41 +02:00
Raymond Hettinger
f6e31b79a8
Issue 23729: Document ElementTree namespace handling and fix an omission in the XPATH predicate table.
2015-03-22 15:29:09 -07:00
R David Murray
beed8402ca
#23539 : Set Content-Length to 0 for PUT, POST, and PATCH if body is None.
...
Some http servers will reject PUT, POST, and PATCH requests if they
do not have a Content-Length header.
Patch by James Rutherford, with additional cleaning up of the
'request' documentation by me.
2015-03-22 15:18:23 -04:00
Benjamin Peterson
218144a94d
clarify behavior of shutil.move when destination exists ( closes #22933 )
...
Patch by Mike Short.
2015-03-22 10:11:54 -04:00
R David Murray
63998a3520
#11726 : Make linecache docs reflect that all files are treated the same.
...
Being able to read non-python text files is not a purpose of linecache, but it
does work and people use it. This changeset adjusts the language to make it
clear that Python files are not treated uniquely, but does not go so far as to
say reading non-python files is explicitly supported.
2015-03-20 11:31:38 -04:00
Victor Stinner
376658fa13
Issue #11726 : Fix linecache example in the doc
...
Use a Python source file (linecache.__file__) instead of /etc/passwd.
Modify also linecache docstrings to clarify the linecache is written to cache
Python source files, not any text files.
2015-03-18 14:16:50 +01:00
Victor Stinner
93f0665fb6
Issue #11726 : clarify linecache doc: linecache is written to cache Python
...
source files, even if "it works" with other text files encoded to UTF-8.
2015-03-18 14:14:42 +01:00
Benjamin Peterson
59c4eb71f2
versionchanged for rc4 removal ( closes #23679 )
2015-03-16 12:43:38 -05:00
Eli Bendersky
39430daa3b
Issue #23549 : Clarify confusion in heapq doc - accessing the mininmal element
...
The current documentation only mentions heap[0] as the smallest element in the
beginning, and not in any of the methods' docs. There's no method to access the
minimal element without popping it, and the documentation of nsmallest is
confusing because it may suggest that min() is the way to go for n==1.
2015-03-14 20:14:23 -07:00
Serhiy Storchaka
b19542d062
Fix minor docs markup errors.
2015-03-14 21:32:57 +02:00
Benjamin Peterson
0d70ab6b8c
__getslice__ certainly won't appear in the output
2015-03-13 16:21:23 -05:00
Benjamin Peterson
f0f14f72bb
use the meth role for ZipFile.open
2015-03-12 22:41:06 -05:00
Berker Peksag
ce77ee9183
Issue #22154 : Add an example to show context management protocol support of ZipFile.open().
...
Patch by Mike Short.
2015-03-13 02:29:54 +02:00
Serhiy Storchaka
a60c2fe480
Issue #23641 : Cleaned out legacy dunder names from tests and docs.
...
Fixed 2 to 3 porting bug in pynche.ColorDB.
2015-03-12 21:56:08 +02:00
Victor Stinner
84c717dd9e
asyncio doc: changes on the Queue API missed Python 3.4.3 release
2015-03-10 16:27:54 +01:00
Berker Peksag
77a6b20a35
Issue #23432 : Remove duplicate content from SystemExit docs.
...
Also, document SystemExit.code attribute explicitly.
2015-03-10 14:47:15 +02:00
Victor Stinner
47c41b4e4d
Issue #23605 : os.walk() doc now mentions shutil.rmtree() in the last example
2015-03-10 13:31:47 +01:00
Ned Deily
8be2142377
Issue #23617 : Correct plurals typo noted by Kentrell Johnson.
2015-03-09 01:55:02 -07:00
Benjamin Peterson
c8358273ae
indicate correct version ( closes #23608 )
2015-03-08 09:42:25 -04:00
Benjamin Peterson
8c69ecf95d
replace Amazon links in the documentation ( closes #23579 )
...
Patch by Sayan Chowdhury.
2015-03-07 09:34:16 -05:00
Benjamin Peterson
990fcaac3c
expose X509_V_FLAG_TRUSTED_FIRST
2015-03-04 22:49:41 -05:00
Benjamin Peterson
bdf525b77c
wrap everything at 80 chars
2015-03-02 09:31:40 -05:00
Benjamin Peterson
29fec92875
link to the correct dis method or function ( closes #23561 )
2015-03-02 09:27:43 -05:00
Berker Peksag
ab4040e3c6
Issue #20521 : Change ``TOS`` to TOS in dis documentation.
...
TOS is an abbreviation of top-of-stack.
Patch by Sven Berkvens-Matthijsse.
2015-03-02 06:33:30 +02:00
Zachary Ware
0b49637890
Fix copy/paste error in bytes.isupper() doc.
...
Reported by Jon Colburn on docs@.
2015-02-27 01:40:22 -06:00
Victor Stinner
7b2c3c6840
asyncio doc: lock classes are not thread safe
2015-02-26 10:39:16 +01:00
Victor Stinner
83704963c0
asyncio: add a note about (non) thread safety in each class
2015-02-25 14:24:15 +01:00
Victor Stinner
532c69a428
asyncio doc: begin with warnings on asyncio traps
2015-02-25 14:23:51 +01:00
Victor Stinner
615a58eaab
asyncio doc: move queues to a new page
2015-02-25 13:55:43 +01:00
Georg Brandl
7e91af3a91
Remove unsupported (in latex) character from the source.
2015-02-25 13:05:53 +01:00
Victor Stinner
b8064a8a16
asyncio doc: close explicitly event loops
2015-02-23 11:41:56 +01:00
Ned Deily
75790938a4
Issue #23499 : Fix grammar error noticed by SilentGhost
2015-02-22 16:14:32 -08:00
Serhiy Storchaka
a3369a524c
Issues #814253 , #9179 : Warnings now are raised when group references and
...
conditional group references are used in lookbehind assertions in regular
expressions.
2015-02-21 12:08:52 +02:00
Berker Peksag
babc688180
Issue #23439 : Add missing entries to http.client.__all__.
...
Also, document the LineTooLong exception since it can be raised by
the members of public API (e.g. http.client.HTTPResponse).
Patch by Martin Panter.
2015-02-20 09:39:38 +02:00
Zachary Ware
56dee1e463
Fix typo pointed out on docs@ by Yaniv Sayeh
2015-02-19 22:30:15 -06:00
Benjamin Peterson
70e2847347
document the requestline and close_connection attributes, use real booleans, and add tests ( closes #23410 )
...
Patch by Martin Panter.
2015-02-17 21:11:10 -05:00
Victor Stinner
f91d845797
asyncio, Tulip issue 220: Update doc of asyncio.Queue, add join and task_done
...
methods
2015-02-17 23:09:52 +01:00
Berker Peksag
4d6c6063bf
Fix typo in os.supports_effective_ids documentation.
2015-02-16 03:36:10 +02:00
Berker Peksag
50ef8a8e67
Issue #13637 : Remove outdated versionchanged directives.
...
Patch by Martin Panter.
2015-02-15 00:05:42 +02:00
Victor Stinner
bdd574d09a
asyncio doc: annotate coroutine on coroutine functions and methods
2015-02-12 22:49:18 +01:00
Ned Deily
50afcc09ac
Fix missing :ref: for idle in doc build.
2015-02-06 15:42:06 +11:00
Victor Stinner
6a1b004b83
asyncio doc: explain how to display ResourceWarning in the debug mode section
2015-02-04 16:14:33 +01:00
Victor Stinner
17d87f8ae4
asyncio, Tulip issue 221: Fix doc of QueueEmpty and QueueFull
2015-02-03 15:09:24 +01:00
Serhiy Storchaka
c057c3859c
Issue #23099 : Closing io.BytesIO with exported buffer is rejected now to
...
prevent corrupting exported buffer.
2015-02-03 02:00:18 +02:00
R David Murray
756f0b1982
Fix asyncio doc typo.
2015-01-29 19:53:33 -05:00
Victor Stinner
188f2c0b75
asyncio doc: document the new ResourceWarning warnings
2015-01-30 01:35:14 +01:00
Victor Stinner
1077dee457
asyncio doc: add a section about task cancellation
2015-01-30 00:55:58 +01:00
Victor Stinner
7a55b88d9c
Issue #21962 , asyncio doc: Suggest the usage of wait_for() to replace
...
the lack of timeout parameter for locks and queues.
2015-01-30 00:37:04 +01:00
Victor Stinner
54a231d539
asyncio doc: document Protocol state machine
2015-01-29 13:33:15 +01:00
Serhiy Storchaka
b76bcc4ffc
Issue #14099 : Backout changeset e5bb3044402b (except adapted tests).
2015-01-26 13:45:39 +02:00
Serhiy Storchaka
2bef58577f
Issue #18518 : timeit now rejects statements which can't be compiled outside
...
a function or a loop (e.g. "return" or "break").
2015-01-26 12:09:17 +02:00
R David Murray
1923b627b5
#23215 : reflow paragraph.
2015-01-25 15:46:22 -05:00
R David Murray
f1f9675b8a
#23251 : Note that time.sleep affects the calling thread only.
...
This change parallels the language used in the unix man page.
2015-01-25 15:45:14 -05:00
Vinay Sajip
ff37cfe9cc
Issue #23305 : clarified RotatingFileHandler documentation.
2015-01-23 21:19:04 +00:00
Berker Peksag
5a494f6ad8
Issue #22317 : Document the action parameter in ArgumentParser.add_subparsers() docs.
...
Patch by Mike Short.
2015-01-20 06:45:53 +02:00
Serhiy Storchaka
d3faf43f9b
Issue #23181 : More "codepoint" -> "code point".
2015-01-18 11:28:37 +02:00
Ned Deily
ccb416fee2
Issue #23180 : Rename IDLE "Windows" menu item to "Window".
...
Patch by Al Sweigart.
2015-01-17 21:06:27 -08:00
Ethan Furman
8a12329281
Issue22997: minor doc update; thanks to Simoen Visser
2015-01-14 22:31:50 -08:00
Benjamin Peterson
82f34ada45
fix instances of consecutive articles ( closes #23221 )
...
Patch by Karan Goel.
2015-01-13 09:17:24 -05:00
Antoine Pitrou
73dd030c8b
Issue #22952 : improve multiprocessing doc introduction and defer notes until appropriate.
...
Patch by Davin Potts.
2015-01-11 15:05:29 +01:00
Mark Dickinson
dfe0b2326b
Issue #21902 : Replace incorrect 'hyperbolic arc sine' (etc.) with 'inverse hyperbolic sine' (etc.). Remove meaningless reference to radians.
2015-01-11 13:08:05 +00:00
Victor Stinner
7eb10311be
asyncio: SelectSelector is limited to 512 sockets on Windows
2015-01-09 15:59:44 +01:00
Victor Stinner
a092a615f5
asyncio doc: fix section of event loop examples
2015-01-09 15:58:41 +01:00
Victor Stinner
399c59d7bd
asyncio doc: list limitations to run subprocesses from different threads
2015-01-09 01:32:02 +01:00
Berker Peksag
283f1aa881
Issue #20487 : Clarify meaning of "side effect" in the magic mock documentation.
...
Patch by A.M. Kuchling.
2015-01-07 21:15:02 +02:00
Nick Coghlan
b9fdb7a452
Issue 19548: update codecs module documentation
...
- clarified the distinction between text encodings and other codecs
- clarified relationship with builtin open and the io module
- consolidated documentation of error handlers into one section
- clarified type constraints of some behaviours
- added tests for some of the new statements in the docs
2015-01-07 00:22:00 +10:00
Zachary Ware
5819cfa5aa
Cosmetic fixes to the 'Develop with asyncio' page
2015-01-06 00:40:43 -06:00
Benjamin Peterson
b461000a3f
the current marshal version is 4 ( closes #23167 )
...
Patch by Dmitry Kazakov.
2015-01-04 16:29:48 -06:00
Benjamin Peterson
bab69bf655
update docs for #23111
2014-12-30 15:17:03 -06:00
Benjamin Peterson
5feeebaa84
use a proper m-dash
2014-12-28 22:14:15 -06:00
Berker Peksag
a1a1409e42
Issue #23125 : Update nose project page link.
...
Reported by Damien Marié.
2014-12-28 18:48:33 +02:00
R David Murray
8c4e112afc
#23040 : Clarify treatment of encoding and errors when component is bytes.
...
Patch by Wojtek Ruszczewski.
2014-12-24 21:23:18 -05:00
Victor Stinner
4f9b773a64
asyncio doc: Fix doc of get and put methods of Queue
2014-12-22 22:07:06 +01:00
Barry Warsaw
904c481099
Fix typo.
2014-12-19 11:20:00 -05:00
Raymond Hettinger
558dcf38e6
Issue #23049 : Pure python equivalent shouldn't imply more exactitude than is really there.
2014-12-16 18:16:57 -08:00
Victor Stinner
4d5115c7b5
asyncio doc: call_soon() does not call immediatly the callback. Patch written
...
by Martin Panter.
2014-12-15 17:50:55 +01:00
Raymond Hettinger
d2a296a73a
Issue 23005: Fix typos
2014-12-11 23:56:32 -08:00
Serhiy Storchaka
b252b5ab0c
Issue #22823 : Fixed an output of sets in examples.
2014-12-11 10:30:21 +02:00
Terry Jan Reedy
e40031d1db
whitespace
2014-12-10 18:49:58 -05:00
Terry Jan Reedy
06c6218d00
Issue #23006 whitespace
2014-12-10 18:48:23 -05:00
Terry Jan Reedy
b67f6e27e1
Issue #23006 : Improve the documentation and indexing of dict.__missing__.
...
Add an entry in the language datamodel special methods section.
Revise and index its discussion in the stdtypes mapping/dict section.
2014-12-10 18:38:19 -05:00
Berker Peksag
8b1cbd2b7c
Issue #12602 : Add missing cross-references to runpy and using/cmdline docs.
...
Patch by Éric Araujo.
2014-12-10 01:47:02 +02:00
Benjamin Peterson
e3b743cd3e
fix reference by adding module name
2014-12-07 17:26:38 -05:00
Benjamin Peterson
a090f01bb6
HTTPSConnection: prefer the context's check_hostname attribute over the constructor parameter ( #22959 )
2014-12-07 13:18:25 -05:00
Benjamin Peterson
b92fd01189
note that sslv3 may not be available
2014-12-06 11:36:32 -05:00
Serhiy Storchaka
b757c83ec6
Issue #22581 : Use more "bytes-like object" throughout the docs and comments.
2014-12-05 22:25:22 +02:00
Terry Jan Reedy
3ab745e386
Edit Menus section of Idle doc. Make menu entries match current Idle in order
...
and case. Edit some of the explanatory sentences and end all with a period.
2014-12-05 02:43:07 -05:00
Yury Selivanov
a5ef83244b
docs.inspect: Fix BoundArguments example. Issue #22998 .
2014-12-04 22:47:44 -05:00
Terry Jan Reedy
bb37b4ca73
Issue #3068 : Document the new Configure Extensions dialog and menu entry.
2014-12-04 01:26:04 -05:00
Terry Jan Reedy
f56849486b
Issue #16893 : For Idle doc, move index entries, copy no-subprocess section
...
from idlelib/help.txt, add 'C' comment, and remove obsolete ^Z comment
Original patch by Zach Ware.
2014-12-04 00:54:59 -05:00
Antoine Pitrou
2b207badd6
Fix #22987 : update the compatibility matrix for a SSLv23 client.
2014-12-03 20:00:56 +01:00
Serhiy Storchaka
1ad088f3ea
Issue #14099 : ZipFile.open() no longer reopen the underlying file. Objects
...
returned by ZipFile.open() can now operate independently of the ZipFile even
if the ZipFile was created by passing in a file-like object as the first
argument to the constructor.
2014-12-03 09:11:57 +02:00
Victor Stinner
d87de83582
Closes #22475 : asyncio doc, fix Task.get_stack() doc
2014-12-02 17:57:04 +01:00
Victor Stinner
039f703b7b
Close #22473 : asyncio doc: rephrase Future with run_forever() example
2014-12-02 17:52:45 +01:00
Serhiy Storchaka
56a6d855e2
Removed duplicated words in in comments and docs.
2014-12-01 18:28:43 +02:00
Benjamin Peterson
b7138e24e3
context is keyword-only
2014-11-29 23:38:17 -05:00
Benjamin Peterson
c1da3d1ed8
add context parameter to xmlrpclib.ServerProxy ( #22960 )
...
Patch by Alex Gaynor.
2014-11-29 23:32:57 -05:00
Victor Stinner
e7182979d6
Closes #22348 : Rephrase asyncio.StreamWriter.drain() documentation
...
Patch written by Martin Richard.
2014-11-28 17:45:41 +01:00
Victor Stinner
1deee54e0c
asyncio doc: reformat event loop policy doc
2014-11-28 13:58:28 +01:00
Victor Stinner
8464c24c82
asyncio doc: explain how to pass keywords to callbacks (functools.partial)
2014-11-28 13:15:41 +01:00
Serhiy Storchaka
7a6915e17d
Issue #21514 : The documentation of the json module now refers to new JSON RFC
...
7159 instead of obsoleted RFC 4627.
2014-11-27 19:41:47 +02:00
Zachary Ware
4847035458
pydoc: Add a note about setting PAGER to affect console output pagination.
...
Suggested by James Lowden on docs@.
2014-11-26 23:44:25 -06:00
Ethan Furman
b004943e9b
(3.4) Issue22780: reword NotImplemented docs to emphasise should
2014-11-26 21:15:35 -08:00
Zachary Ware
61aebca09d
pydoc: Remove mention of '-g' command line option, document its removal.
2014-11-26 22:57:35 -06:00
Berker Peksag
c8c64e30e8
Issue #20351 : Add examples for csv.DictReader and csv.DictWriter.
...
Patch by Charles-Axel Dein.
2014-11-24 23:46:30 +02:00
Benjamin Peterson
43052a14c1
add context parameter to HTTPHandler ( closes #22788 )
2014-11-23 20:36:44 -06:00
Benjamin Peterson
dbd4bcfcca
correct versionchanged version
2014-11-23 20:09:31 -06:00
Benjamin Peterson
7243b574e5
don't require OpenSSL SNI to pass hostname to ssl functions ( #22921 )
...
Patch by Donald Stufft.
2014-11-23 17:04:34 -06:00
Benjamin Peterson
378e15d7ab
document that cadefault does nothing now
2014-11-23 11:43:33 -06:00