Commit graph

6208 commits

Author SHA1 Message Date
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