Commit Graph

3912 Commits

Author SHA1 Message Date
Senthil Kumaran f21804ad61 Issue #13685 - Update argparse help message for % sign usage. 2012-06-26 14:17:19 +08:00
Larry Hastings c48fe98a7c Issue #15177: Added dir_fd parameter to os.fwalk(). 2012-06-25 04:49:05 -07:00
Larry Hastings fdaea06d3c Issue #15176: Clarified behavior, documentation, and implementation
of os.listdir().
2012-06-25 04:42:23 -07:00
Larry Hastings 77892dc1e3 More doc fixes: made it clear where to start reading when you click on <dir_fd>. 2012-06-25 03:27:33 -07:00
Georg Brandl aceaf90804 Some tightening of the documentation for the new kwarg-style os module functionality. 2012-06-25 08:33:56 +02:00
Larry Hastings 48986d68c2 Minor grammar refinement for hmac.compare_digest(). 2012-06-25 00:59:34 -07:00
Georg Brandl 4d399a4092 Grammar fix. 2012-06-25 07:40:32 +02:00
Larry Hastings 68386bc0b8 Issue #15164: Change return value of platform.uname() from a
plain tuple to a collections.namedtuple.
2012-06-24 14:30:41 -07:00
Georg Brandl 61063cca6a Fix a couple of versionadded/versionchanged related markup errors. 2012-06-24 22:48:30 +02:00
Georg Brandl 33369cf9a5 Fix a bunch of "versionchanged" related markup errors. 2012-06-24 22:48:03 +02:00
Georg Brandl 217aa554fa Fix markup, for real this time. 2012-06-24 22:26:21 +02:00
Éric Araujo b0f0895849 Fix indentation 2012-06-24 16:22:09 -04:00
Ezio Melotti 46495182d0 #15156: HTMLParser now uses the new "html.entities.html5" dictionary. 2012-06-24 22:02:56 +02:00
Éric Araujo 56261cff16 Branch merge 2012-06-24 13:54:22 -04:00
Éric Araujo 544e13d126 Fix markup 2012-06-24 13:53:48 -04:00
Éric Araujo 0a8f5f709a Fix typos 2012-06-24 13:53:41 -04:00
Georg Brandl 19c4e5bb39 Fix test__locale on Mac; platform.uname() does not have a structseq-type interface (yet). 2012-06-24 19:29:49 +02:00
Georg Brandl 03b9ad05d6 Add a single versionadded for a whole section instead of repeating for every function. 2012-06-24 18:09:40 +02:00
Georg Brandl 96acb73dd5 Small whitespace fixes for shutil.rmtree() docs. 2012-06-24 17:39:05 +02:00
Georg Brandl 4a7e25f4df #444582: fix example and rewrap docs a bit. 2012-06-24 17:37:07 +02:00
Georg Brandl dbab58fdeb Refactor the venv API docs into a real API doc style. 2012-06-24 16:37:59 +02:00
Antoine Pitrou 5f762af3bc Remove a detailed discussion of content-based short circuiting, off topic for library docs. 2012-06-24 16:23:54 +02:00
Antoine Pitrou f61e7910ea Simplify wording. 2012-06-24 16:21:10 +02:00
Antoine Pitrou 1524d7556d Formatting 2012-06-24 16:18:48 +02:00
Hynek Schlawack 1729b8f45b Fix doc of os.fwalk: example used now non-existing os.fstatat() 2012-06-24 16:11:08 +02:00
Georg Brandl ae64b4d8e2 Merge heads. 2012-06-24 16:11:23 +02:00
Georg Brandl 3b44d81cf9 Merge heads. 2012-06-24 16:10:47 +02:00
Georg Brandl a1bc35f07f Improve hmac.compare_digest() docstring and documentation, courtesy of Larry H. 2012-06-24 16:07:33 +02:00
Antoine Pitrou 4f9946874b The buffer protocol doesn't exist (in the glossary anyway). 2012-06-24 16:04:38 +02:00
Antoine Pitrou 9df73dac84 Larry's suggested rewording of the compare_digest() docs. 2012-06-24 16:03:50 +02:00
Georg Brandl 6cff9ffab0 Fix use of class markup. 2012-06-24 14:05:40 +02:00
Christian Heimes 6cea65555c Issue #15061: Re-implemented hmac.compare_digest() in C 2012-06-24 13:48:32 +02:00
Larry Hastings 605a62ddb1 Issue #15118: Change return value of os.uname() and os.times() from
plain tuples to immutable iterable objects with named attributes
(structseq objects).
2012-06-24 04:33:36 -07:00
Georg Brandl f62445ad30 Fix casing of Unix. 2012-06-24 13:31:20 +02:00
Georg Brandl 8a5555f792 Make the style of the "Availability" sections consistent. 2012-06-24 13:29:09 +02:00
Georg Brandl a570e98e7b Actually it is just one function. 2012-06-24 13:26:22 +02:00
Georg Brandl b2462e2b8c Minor clarification about fdopen(). 2012-06-24 13:24:56 +02:00
Georg Brandl b8f2d29ea9 Remove attribution; this is for the whatsnew. 2012-06-24 13:06:44 +02:00
Georg Brandl 306336bcda Closes #15161: add support for giving path as a fd for truncate() and pathconf(). 2012-06-24 12:55:33 +02:00
Georg Brandl 8ccadaafe6 Restore mostly-alphabetic sorting of os functions. 2012-06-24 12:50:06 +02:00
Georg Brandl b9df00cc00 Note that equivalents are valid for 3.3+ only. 2012-06-24 12:38:14 +02:00
Georg Brandl b9831ab63c Move Linux-only *xattr() functions to their own subheading. 2012-06-24 11:57:07 +02:00
Georg Brandl 7ac2af78a2 Fix typo. 2012-06-24 11:56:47 +02:00
Georg Brandl b1a1ac0b67 Small nits in os doc. 2012-06-24 11:54:07 +02:00
Georg Brandl 50c4000685 "Refactor" docs for the new dir_fd, follow_symlinks, path-as-fd APIs: document the options at a central place and link to it. 2012-06-24 11:45:20 +02:00
R David Murray 97f43c019f #15160: Extend the new email parser to handle MIME headers.
This code passes all the same tests that the existing RFC mime header
parser passes, plus a bunch of additional ones.

There are a couple of commented out tests where there are issues with the
folding.  The folding doesn't normally get invoked for headers parsed from
source, and the cases are marginal anyway (headers with invalid binary data)
so I'm not worried about them, but will fix them after the beta.

There are things that can be done to make this API even more convenient, but I
think this is a solid foundation worth having.  And the parser is a full RFC
parser, so it handles cases that the current parser doesn't.  (There are also
probably cases where it fails when the current parser doesn't, but I haven't
found them yet ;)

Oh, yeah, and there are some really ugly bits in the parser for handling some
'postel' cases that are unfortunately common.

I hope/plan to to eventually refactor a lot of the code in the parser which
should reduce the line count...but there is no escaping the fact that the
error recovery is welter of special cases.
2012-06-24 05:03:27 -04:00
Sandro Tosi 27b130e702 Issue #15060: better fix, thanks to review on #python-dev 2012-06-14 00:37:09 +02:00
Sandro Tosi 56692f5722 Issue #15060: fix typo in socket doc; Patch by anatoly techtonik 2012-06-13 23:58:54 +02:00
Sandro Tosi 964f205a34 refer to time.strftime 2012-06-02 18:22:02 +02:00
R David Murray 554b3481fa #14957: fix doc typo. 2012-06-02 11:20:29 -04:00
R David Murray ae1b94b6e4 #14957: clarify splitlines docs.
Initial patch by Michael Driscoll, I added the example.
2012-06-01 16:19:36 -04:00
Sandro Tosi 3f7d1d3303 Issue #14968: set 'Inplace Operators' as subsection; patch by Lars Buitinck 2012-06-01 20:23:20 +02:00
Brian Curtin 13c70345ca Fix #14943. Update the proper default value and list the proper argument names in the explanation. 2012-05-29 18:34:45 -05:00
R David Murray e1398f77ea #11785: fix the :mod: references in email package submodule titles. 2012-05-27 17:17:53 -04:00
Petri Lehtinen 1a01ebc41c #14863: Update the documentation of os.fdopen()
There's no bufsize argument anymore, and os.fdopen() is only a very
thin wrapper around open() anymore. Change the documentation to
reflect that.
2012-05-24 21:46:36 +03:00
Hynek Schlawack 979f37afd2 Restore [] where default arguments are not keywords
Reverts some changes of d13fdd97cc8e.
2012-05-22 16:12:18 +02:00
Hynek Schlawack dfa465243c #14804: Remove [] around optional arguments with default values 2012-05-21 11:01:54 +02:00
Hynek Schlawack f54c0604c8 Fix `versionchanged` tags for json.load
`versionchanged` tags about 2.7 are useless in 3.x branches.
2012-05-20 18:32:53 +02:00
Vinay Sajip 69d8493899 Fixes #14864: Added documentation on how to undo the effects of a logging.disable() call. 2012-05-20 15:36:17 +01:00
Hynek Schlawack 1203e83d28 Document when json.load's parse_constant behaviour changed
It doesn't get called on 'null', 'true', 'false' since f686aced02a3.
2012-05-20 12:03:17 +02:00
Petri Lehtinen 079bfc962d #14494: Document that absolute imports became default in 3.0 instead of 2.7. 2012-05-19 18:36:33 +03:00
Petri Lehtinen 1033b310a3 Fix time.time() references in the time module docs
Closes #14842.
2012-05-18 21:22:47 +03:00
R David Murray f7a6615719 #14823: Simplify threading.Lock.acquire argument discussion. 2012-05-17 09:13:30 -04:00
Hynek Schlawack 9729fd4427 #14692 Fix json docs to reflect changes in json.load
The behaviour of the parse_constant callback changed insofar that 'null',
'true', 'false' don't trigger its call anymore.

Patch by Serhiy Storchaka
2012-05-16 19:01:04 +02:00
R David Murray 28e68ea6ea #1440472: reflow 2012-05-15 22:13:29 -04:00
R David Murray ea1badbfef #1440472: Explain that email parser/generator isn't *quite* "idempotent" 2012-05-15 22:07:52 -04:00
R David Murray 539f239e88 #14766: Reflow the altered paragraphs. 2012-05-14 22:17:23 -04:00
R David Murray 9075d8b771 #14766: Add correct algorithm for when a 'time' object is naive.
This patch also clarifies the definition of Naive and Aware.

Original patch by Greg Weller, I modified the first hunk
somewhat to make the exposition even clearer (I hope).
2012-05-14 22:14:46 -04:00
Sandro Tosi 3918b1ebfb Issue #14793: fix grammar in bytes object paragraph; patch by Tshepang Lekhonkhobe 2012-05-13 11:01:20 +02:00
Sandro Tosi 38b86b4cf5 correctly define what 'fill' could be; thanks to Leland Hulbert from docs@ 2012-05-12 23:29:32 +02:00
Antoine Pitrou a9494f6c53 Some nits in the pickle docs. 2012-05-10 15:38:30 +02:00
Ezio Melotti bf3165b971 #14763: document default maxsplit value for str.split. 2012-05-10 15:30:42 +03:00
R David Murray b98b37f101 Improve the grammar of a non-sentence. 2012-05-08 21:28:24 -04:00
Ezio Melotti 6cc7a41c2f #14034: added the argparse tutorial. Patch by Tshepang Lekhonkhobe. 2012-05-06 16:15:35 +03:00
Ned Deily 2e20968feb Issue #10433: Document unique behavior of 'os.getgroups' on Mac OS X. 2012-04-30 11:14:02 -07:00
Ezio Melotti 3d6d7a5e15 #14558: document the module, argv, and testLoader args of unittest.main. 2012-04-30 19:10:28 +03:00
Senthil Kumaran 290416f364 Issue11352 - Update cgi module docs 2012-04-30 22:43:13 +08:00
Ezio Melotti a0b1d1eea2 #14519: fix the regex used in the scanf example. 2012-04-29 11:47:28 +03:00
Ezio Melotti b8e336b974 Fix markup in unittest doc. 2012-04-29 10:52:18 +03:00
Senthil Kumaran db727b4a77 Fix issue6085 - Remove the delay caused by fqdn lookup while logging in BaseHTTPRequestHandler 2012-04-29 13:41:03 +08:00
Ezio Melotti 0a6b5419b0 #14461: fix wording. 2012-04-29 07:34:46 +03:00
Senthil Kumaran 8dc500476a issue14427 - Document Request.get_header and Request.header_items 2012-04-29 11:50:39 +08:00
Ezio Melotti 285e51b7e0 #14155: add a note about \b. 2012-04-29 04:52:30 +03:00
Sandro Tosi 100b889ccd Issue #14448: add reference to IANA timezone database; thanks to Georg/Nick suggestions 2012-04-28 11:19:37 +02:00
Sandro Tosi d11d0d6343 Issue #14448: mention pytz; patch by Andrew Svetlov 2012-04-24 19:46:06 +02:00
Sandro Tosi 3e29d93007 Issue #14554: correct example for captured_stdout(); patch by Tshepang Lekhonkhobe 2012-04-24 18:39:24 +02:00
Sandro Tosi e6c3462607 Issue #13478: document timeit.default_timer() 2012-04-24 18:11:46 +02:00
Senthil Kumaran a42665f4d4 issue2193 - Update 3.2 docs about legal characters allowed in Cookie name 2012-04-22 10:30:17 +08:00
Ned Deily cc19140607 Remove webbrowser doc reference to the previously removed internet-config option. 2012-04-18 12:48:52 -07:00
Sandro Tosi 1ee17198c8 fix typo; thanks to Jérôme Mainka from docs@ 2012-04-14 16:01:17 +02:00
Ezio Melotti 84e59aa989 Fix highlight and spacing in json example. 2012-04-13 21:02:18 -06:00
Ezio Melotti f86b28e3d2 #14535: fix code highlight in multiprocessing examples. Patch by Tshepang Lekhonkhobe. 2012-04-13 20:50:48 -06:00
R David Murray e7bade568e #14553: fix word order.
Patch by Tshepang Lekhonkhobe.
2012-04-11 20:13:25 -04:00
R David Murray 644cabed4b #14552: remove redundant wording in 'test' docs.
Original patch by Tshepang Lekhonkhobe.
2012-04-11 20:11:53 -04:00
Antoine Pitrou f6cd9b2d46 Improve the threading.Condition docs. 2012-04-11 19:37:56 +02:00
Georg Brandl 2c5807572f Closes #14545: make clearer what was added. 2012-04-11 18:33:17 +02:00
Antoine Pitrou b96a354556 Small improvements to the threading docs: better publicize support for the with statement. 2012-04-10 22:47:55 +02:00
Antoine Pitrou 2c9f1042c6 Fix some markup in the threading docs. 2012-04-10 22:35:53 +02:00
Antoine Pitrou 126aef768d Issue #8799: Fix and improve the threading.Condition documentation. 2012-04-10 22:24:05 +02:00
Vinay Sajip 074faff925 Updated logging reference and HOWTO. 2012-04-10 19:59:50 +01:00