Commit Graph

3020 Commits

Author SHA1 Message Date
Senthil Kumaran 2e0153550c Fix closes Issue12697 - Update the usage syntax of timeit module in the docs. 2011-08-06 13:37:04 +08:00
Éric Araujo de4f05b741 Improve documentation for PEP 370 support in site module (#8617).
site.USER_BASE and site.USER_SITE are now fully documented.  PEP 370 is
outdated with respects to the Mac framework situation, but the code in
sysconfig and the example in the 3.2 What’s New document helped me find
the right values to document for Mac OS X.

The command-line interface of the site module, partly documented in the
3.2 What’s New, is fully described in the module docs.

The purpose of the usercustomize module is explained in the site docs,
with a gentle introduction in the tutorial (right after the section that
talks about PYTHONSTARTUP; a comment mentions it should be moved from
the tutorial to another file, but that will be another bug).

Various markup and wording improvements were made along the way in the
site module docs.  Duplicate and incomplete declarations of environment
variables have also been removed (the original bug report was actually
about these entries :).  The site module docs are still a bit messy;
I’ll see about improving them for #11553.

All these sections are copiously interlinked and findable from the doc
indexes.
2011-08-06 01:51:07 +02:00
Senthil Kumaran 90ceb4772b Fix closes issue12663 - Correcting the ArgumentParser.error description. Patch by Sandro Tosi. 2011-08-03 07:43:01 +08:00
Senthil Kumaran 86a1a8974d Fix closes issue12663 - Correcting the ArgumentParser.error description. Patch by Sandro Tosi. 2011-08-03 07:42:18 +08:00
Benjamin Peterson 94b580d423 expose sched.h functions (closes #12655) 2011-08-02 17:30:04 -05:00
Sandro Tosi e4f9e2ff21 #12665: merge with 3.2 2011-08-02 18:43:49 +02:00
Sandro Tosi 2a8d195328 #12665: Dictionary view example has error in set operation 2011-08-02 18:42:04 +02:00
Sandro Tosi b1290a5295 #12670: merge with 3.2 2011-08-02 16:44:31 +02:00
Ezio Melotti 3083c88898 #12183: merge with 3.2. 2011-08-02 17:42:24 +03:00
Sandro Tosi 692dba244b #12670: Fix struct code after forward declaration on ctypes doc 2011-08-02 16:17:14 +02:00
Senthil Kumaran ef5c716176 Fix closes Issue12183 - Explain the Symlink copy behavior in shutil.copytree. Patch by Petri Lehtinen. 2011-08-02 18:52:28 +08:00
Georg Brandl b0fa4b8433 Merge with 3.2 2011-08-01 22:59:40 +02:00
Georg Brandl aa71583f09 Use attribute access instead of index access for namedtuple. 2011-08-01 22:58:53 +02:00
Vinay Sajip b07df00bce Closes #12667: Merged fix from 3.2. 2011-08-01 11:32:49 +01:00
Vinay Sajip 952595696a Closes #12667: Added documentation for SMTPHandler secure argument. 2011-08-01 11:31:52 +01:00
Senthil Kumaran b351a48eee Addressing the review comments by Antoine Pitrou for smtplib.py and test_smtplib.py. Review comments by Ezio Melotti for smtplib.rst 2011-07-31 09:14:17 +08:00
Benjamin Peterson 98f2b9bff0 transition move technically correct to obviously so 2011-07-30 12:26:27 -05:00
Benjamin Peterson 2c69e3dd82 we can call singleton types now 2011-07-30 10:03:09 -05:00
Benjamin Peterson 7f94febd74 merge 3.2 2011-07-30 10:00:02 -05:00
Benjamin Peterson 497cd65cec add space 2011-07-30 09:59:50 -05:00
Benjamin Peterson 50211fa0f9 document NotImplemented 2011-07-30 09:57:24 -05:00
Eli Bendersky b603b27775 merging Georg's revision 2011-07-30 11:36:41 +03:00
Eli Bendersky d18ee3bf14 Merge 3.2: Issue #11699: fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen 2011-07-30 11:24:38 +03:00
Eli Bendersky e250358062 Issue #11699: fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen 2011-07-30 11:14:32 +03:00
Georg Brandl 39112a9643 Merge with 3.2. 2011-07-30 09:01:03 +02:00
Georg Brandl eea6cda91a Change test.support docs to be more specific about the nature of this module. 2011-07-30 09:00:48 +02:00
Senthil Kumaran 63d4fb4cf2 fixing the smtplib.rst whitespaces. 2011-07-30 10:58:30 +08:00
Senthil Kumaran 3d23fd6493 Fix closes Issue11281 - smtplib.STMP gets source_address parameter, which adds the ability to bind to specific source address on a machine with multiple interfaces. Patch by Paulo Scardine. 2011-07-30 10:56:50 +08:00
Éric Araujo 516c51c14c Merge from 3.2 (#9254, #8982, #9788) 2011-07-29 18:10:12 +02:00
Éric Araujo fe1e298d8b Document that atexit execution order is undefined (#9788) 2011-07-29 18:04:24 +02:00
Éric Araujo 63b18a4445 Add a link target for argparse.Namespace (#8982) 2011-07-29 17:59:17 +02:00
Éric Araujo e801aa2a1d Let the doc of __import__ link to importlib (#9254).
importlib.import_module eschews a number of issues that __import__ has.
Reviewed by Brett Cannon.  (The docstring of __import__ was already
updated in 3d490c3a019e, for #7397.)
2011-07-29 17:50:58 +02:00
Éric Araujo 30e277bf72 Expand shlex.quote example (#9723) 2011-07-29 15:08:42 +02:00
Éric Araujo 0bbacc621c Branch merge 2011-07-29 14:30:03 +02:00
Éric Araujo 158d7696f3 Branch merge 2011-07-29 14:24:08 +02:00
Eli Bendersky 1d8b968c68 Merge from 3.2: Issue #12644: document the '%a' conversion in the old string formatting operations. Patch prepared together with Ezio Melotti 2011-07-29 09:33:50 +03:00
Eli Bendersky ef4902af87 Issue #12644: document the '%a' conversion in the old string formatting operations. Patch prepared together with Ezio Melotti 2011-07-29 09:30:42 +03:00
Éric Araujo 2527796a22 Merge from 3.2 (#10318, #12255, #12043, #12417 and other fixes) 2011-07-29 03:11:09 +02:00
Éric Araujo cf534817ad Branch merge 2011-07-28 23:08:11 +02:00
Éric Araujo fc662ddda2 Merge profile docs followup (#12417) from 3.1 2011-07-28 23:00:14 +02:00
Éric Araujo ee19c772cb Remove mentions of previous license in profile module docs (#12417 followup).
Also remove an extra docstring.
2011-07-28 22:56:24 +02:00
Éric Araujo 14382dc887 Update documentation for shutil.move (#12043) and fix a few typos.
Adding Sandro Tosi to Doc/ACKS for this patch and all his work on the
docs mailing list and on the bug tracker.
2011-07-28 22:49:11 +02:00
Eli Bendersky c353f68b1d fix doc typo for library/test.rst 2011-07-27 20:29:59 +03:00
Éric Araujo 9bce311ea4 Add shlex.quote function, to escape filenames and command lines (#9723).
This function used to live as pipes.quote, where it was undocumented but
used anyway.  (An alias still exists for backward compatibility.)  The
tests have been moved as is, but the code of the function was changed to
use a regex instead of a loop with string comparisons (at Ian Bicking’s
suggestion).  I’m terrible at regexes, so any feedback is welcome.
2011-07-27 18:29:31 +02:00
Éric Araujo 59e387eb40 Fix “anyways” (following R. David Murray in 4d5a546b6186) 2011-07-26 16:53:17 +02:00
Ezio Melotti 04f648cb90 #12547: Fix example in nntplib doc. Patch by July Tikhonov. 2011-07-26 09:37:46 +03:00
Charles-François Natali acd9f7ce32 Issue #11784: Improve multiprocessing.Process.join() documentation. Patch by
Patrick Sabin.
2011-07-25 18:35:49 +02:00
Ross Lagerwall 432171c687 Issue #12102: Merge with 3.2. 2011-07-25 07:14:15 +02:00
Ross Lagerwall 59c01edcaa Issue #12102: Document that buffered files must be flushed before being used
with mmap. Patch by Steffen Daode Nurpmeso.
2011-07-25 07:12:43 +02:00
Antoine Pitrou 664091be72 Followup to c3b47cdea0d1: document the *write_through* argument to TextIOWrapper. 2011-07-23 22:00:03 +02:00
Antoine Pitrou d649480739 Issue #12551: Provide a get_channel_binding() method on SSL sockets so as
to get channel binding data for the current SSL session (only the
"tls-unique" channel binding is implemented).  This allows the
implementation of certain authentication mechanisms such as SCRAM-SHA-1-PLUS.

Patch by Jacek Konieczny.
2011-07-21 01:11:30 +02:00
R David Murray 875048bd4c #665194: support roundtripping RFC2822 date stamps in the email.utils module 2011-07-20 11:41:21 -04:00
Senthil Kumaran 3e44612726 merge from 3.2 - Fix closes issue12524 - update http.client POST example with a working example. 2011-07-20 21:57:07 +08:00
Senthil Kumaran 96c84a4c7d Fix closes issue12524 - update http.client POST example with a working example. 2011-07-20 21:56:24 +08:00
Senthil Kumaran a8713b141a merge from 3.2 - Fix closes issue12577 - clarify shutil.move documentation. Patch suggestion by Catalin Iacob 2011-07-19 08:03:55 +08:00
Senthil Kumaran ae4a78b0a8 Fix closes issue12577 - clarify shutil.move documentation. Patch suggestion by Catalin Iacob 2011-07-19 08:03:02 +08:00
Antoine Pitrou 6d175b72b5 Issue #6476: Document that os.spawnle and os.spawnve are not thread-safe under Windows. 2011-07-19 01:29:18 +02:00
Antoine Pitrou 0e752dd3f8 Issue #6476: Document that os.spawnle and os.spawnve are not thread-safe under Windows. 2011-07-19 01:26:58 +02:00
Benjamin Peterson bd9c655c97 merge heads 2011-07-17 22:50:12 -05:00
Benjamin Peterson 76f7f4d979 excise the remains of STOP_CODE, which hasn't done anything useful for years 2011-07-17 22:49:50 -05:00
Brett Cannon e52181c05a Add Misc/NEWS entry and relevant doc change for issue 10271. 2011-07-17 19:25:50 -07:00
Senthil Kumaran c32aae0d44 fix whitespace in rst. 2011-07-18 07:18:11 +08:00
Senthil Kumaran 3e7f33fc82 fix whitespace nit. 2011-07-18 07:17:20 +08:00
Senthil Kumaran 029b467963 merge from 3.2 - Fix closes Issue12478 - HTTPErrorProcess 's methods are http_response and https_response. 2011-07-18 07:13:21 +08:00
Senthil Kumaran 0215d09ca9 Fix closes Issue12478 - HTTPErrorProcess 's methods are http_response and https_response. 2011-07-18 07:12:40 +08:00
Senthil Kumaran 3121547f42 merge from 3.2 - Fix closes Issue12479 - Add HTTPErrorProcessor class definition - Patch by Sandro Tosi 2011-07-18 06:43:25 +08:00
Senthil Kumaran ed270fab64 Fix closes Issue12479 - Add HTTPErrorProcessor class definition - Patch by Sandro Tosi 2011-07-18 06:42:46 +08:00
Senthil Kumaran 42d1320c06 merge from 3.2 2011-07-17 19:06:03 +08:00
Senthil Kumaran 023c6f703d Fix Issue10403 - datetime documentation clarification based on review in the reitveld by Alexendar belopolsky. 2011-07-17 19:01:14 +08:00
Senthil Kumaran 87e59cd701 merge from 3.2 2011-07-17 17:32:06 +08:00
Senthil Kumaran ad3882a2b0 Fix closes Issue11436 - Minor clarification to struct documentation for 's' format character. 2011-07-17 17:29:17 +08:00
Benjamin Peterson 0bd152cd67 remove ast.__version__ (closes #12273) 2011-07-15 21:10:13 -05:00
Georg Brandl 5c1190bada Remove duplicate "numbered" options for toctrees. 2011-07-15 19:09:49 +02:00
Éric Araujo dccf9855fc Fix :file: constructs in packaging.database docs 2011-07-15 17:48:20 +02:00
Victor Stinner a7878b77dc Close #6755: Add get_wch() method to curses.window class
Patch by Iñigo Serna.
2011-07-14 23:07:44 +02:00
Ned Deily 07b353716c Issue #12549: Correct test_platform to not fail when OS X returns 'x86_64'
as the processor type on some Mac systems.
2011-07-13 15:09:49 -07:00
Ned Deily 58e3350bd4 Issue #12549: Correct test_platform to not fail when OS X returns 'x86_64'
as the processor type on some Mac systems.  Also fix NameError in fallback
_mac_ver_gestalt function.  And remove out-of-date URL in docs.
2011-07-13 15:07:04 -07:00
Victor Stinner a9a9dab042 Issue #12550: Add chain optional argument to faulthandler.register()
Call the previous signal handler if chain is True.
2011-07-13 23:39:53 +02:00
Antoine Pitrou 126edb5607 Use infinitive, not 3rd person of present tense. 2011-07-11 01:39:35 +02:00
Antoine Pitrou b3593cada2 Use infinitive, not 3rd person of present tense. 2011-07-11 01:39:19 +02:00
Antoine Pitrou f08310f08b Issue #12343: Add some notes on behaviour of non-blocking SSL sockets. 2011-07-11 01:38:27 +02:00
Antoine Pitrou 6f5dcb1ee2 Issue #12343: Add some notes on behaviour of non-blocking SSL sockets. 2011-07-11 01:35:48 +02:00
Antoine Pitrou e1d2103ede Mention logging.captureWarnings in the warnings module doc. 2011-07-09 21:31:07 +02:00
Antoine Pitrou cdddf2b875 Mention logging.captureWarnings in the warnings module doc. 2011-07-09 21:29:36 +02:00
Antoine Pitrou 462d1b39a4 Move sys.subversion at the right place in alphabetical order, and informally deprecate it. 2011-07-09 16:02:19 +02:00
Antoine Pitrou 87fd76edb6 Issue #12326: document the recommended idiom for checking sys.platform on Unix systems.
Also, point to the various alternatives.
2011-07-09 15:55:38 +02:00
Antoine Pitrou a83cdaae89 Issue #12326: document the recommended idiom for checking sys.platform on Unix systems.
Also, point to the various alternatives.
2011-07-09 15:54:23 +02:00
Georg Brandl d3b41c63a6 Fix syntax in packaging docs and update suspicious ignore file. 2011-07-09 11:48:50 +02:00
Victor Stinner 6e2e3b9e81 Issue #12423: Fix os.abort() documentation
The Python signal handler for SIGABRT is not called on os.abort() (only if the
signal is raised manually or sent by another process). Patch by Kamil Kisiel.
2011-07-08 02:26:39 +02:00
Senthil Kumaran 3aac179498 Fix whitespace nit in datetime and os rst files. 2011-07-04 11:43:51 -07:00
Senthil Kumaran a6bac95a3c issue10403 - Let's not use members anymore. Use 'attribute' where it denotes attribute and 'methods' where it denotes methods. Context should clarify usage. 2011-07-04 11:28:30 -07:00
Georg Brandl bfd1edd155 Merge 3.2.1 release clone changes into main 3.2 branch after 3.2.1rc2 release. 2011-07-04 19:55:22 +02:00
Senthil Kumaran 946eb865a3 reST indentation fix in sqlite3 docs. rst uses 3 space indentation. 2011-07-03 10:17:22 -07:00
Georg Brandl f069100d0d Fix bad markup. 2011-07-03 09:39:49 +02:00
Victor Stinner 2b49f12a63 (merge 3.2) Issue #12423: Fix os.abort() documentation
The Python signal handler for SIGABRT is not called on os.abort() (only if the
signal is raised manually or sent by another process). Patch by Kamil Kisiel.
2011-07-08 02:27:06 +02:00
Senthil Kumaran 8fbfc12f5e merge from 3.2 2011-07-04 11:44:17 -07:00
Senthil Kumaran 276a58b821 Merge from 3.2 . Replace the term members with correct and appropriate terminology. Initial patch by Adam Woodbeck. 2011-07-04 11:31:53 -07:00
Georg Brandl 1945f93888 Merge with 3.2. 2011-07-04 19:58:12 +02:00
Senthil Kumaran 37d72b7164 merge from 3.2 2011-07-03 10:23:43 -07:00
R David Murray db4120bf9d merge #12147: make send_message correctly handle Sender and Resent- headers. 2011-07-02 21:10:44 -04:00
R David Murray ac4e5abc78 #12147: make send_message correctly handle Sender and Resent- headers.
Original patch by Nicolas Estibals.  My tweaks to the patch were mostly
style/cosmetic, and adding more tests.
2011-07-02 21:03:19 -04:00
Giampaolo Rodola' 210e7ca032 Issue #12442: add shutil.disk_usage() 2011-07-01 13:55:36 +02:00
Ned Deily 8b56c4b1b8 Issue #8746: Correct faulty configure checks so that os.chflags() and
os.lchflags() are once again built on systems that support these
functions (*BSD and OS X).  Also add new stat file flags for OS X
(UF_HIDDEN and UF_COMPRESSED).  Also add additional tests for
os.chflags() and os.lchflags(). (Tests by Garrett Cooper)
2011-06-28 00:13:01 -07:00
Ned Deily 3eb67d58d6 Issue #8746: Correct faulty configure checks so that os.chflags() and
os.lchflags() are once again built on systems that support these
functions (*BSD and OS X).  Also add new stat file flags for OS X
(UF_HIDDEN and UF_COMPRESSED).  Also add additional tests for
os.chflags() and os.lchflags(). (Tests by Garrett Cooper)
2011-06-28 00:00:28 -07:00
Vinay Sajip 2353e35570 Closes #12419: Added ident to SysLogHandler. 2011-06-27 15:40:06 +01:00
Giampaolo Rodola' 096dcb1eff Issue 12139: add CCC command support to FTP_TLS class to revert the SSL connection back to clear-text. 2011-06-27 11:17:51 +02:00
Ezio Melotti 58ff0039a3 #11363: merge with 3.2. 2011-06-26 13:39:35 +03:00
Ezio Melotti 4850d52b4d #11363: add missing functions from curses doc. Patch by Sandro Tosi. 2011-06-26 13:34:56 +03:00
Ezio Melotti b6b7371329 #11363: clean up curses doc. 2011-06-26 13:38:11 +03:00
Ezio Melotti 54cc5fd72d Use correct markup in zipimport.rst. Patch by Sara Magliacane. 2011-06-25 19:40:06 +03:00
Ezio Melotti 2d826e8f4b Use correct markup in zipimport.rst. Patch by Sara Magliacane. 2011-06-25 19:40:06 +03:00
Raymond Hettinger 9d3df6d508 Issue 11889: Clarify docs for enumerate. 2011-06-25 15:00:14 +02:00
Mark Dickinson 7e4b5c6773 Merge #12228 2011-06-25 12:04:08 +02:00
Mark Dickinson 40d9ebe031 Issue #12228: Fix exchanged flag descriptions in stat.rst. Thanks Sandro Tosi. 2011-06-25 12:03:33 +02:00
Raymond Hettinger 4d5208d2e2 Fix typo (reported by Hiro Ashiya). 2011-06-25 11:39:00 +02:00
Raymond Hettinger 04e1012e2d Issue 11889: Clarify docs for enumerate. 2011-06-25 15:00:46 +02:00
Ross Lagerwall bc808224b6 Issue #12303: Add sigwaitinfo() and sigtimedwait() to the signal module. 2011-06-25 12:13:40 +02:00
Mark Dickinson bb66972c0b Merge #12228 2011-06-25 12:04:45 +02:00
Raymond Hettinger f68f7148d1 Fix typo (reported by Hiro Ashiya). 2011-06-25 11:39:42 +02:00
R David Murray 947d6b0444 merge #9921: clarify os.path.join joining algorithm 2011-06-23 21:26:48 -04:00
R David Murray 24eb4bc5c9 #9921: clarify os.path.join joining algorithm
The new wording is based on the comments in the code, which
match the actual behavior.
2011-06-23 21:26:13 -04:00
R David Murray 3a420c752d #10354: remove last public mentions of 'template' and comment as private.
I didn't rename the variable because I can see no good reason
to break backward compatibility just to put an underscore in
the name.
2011-06-22 21:01:13 -04:00
Senthil Kumaran d6b3840e7d merge from 3.2 2011-06-19 18:23:17 -07:00
Senthil Kumaran 656df5ec3e Fix closes issue 12360 - correcting parameter names in asyncore documentation. 2011-06-19 18:22:33 -07:00
Senthil Kumaran 110cac1523 merge from 3.2 2011-06-19 17:00:29 -07:00
Senthil Kumaran fd8d7e9b0d Whitespace nit fixed using reident. 2011-06-19 16:59:41 -07:00
Senthil Kumaran 9f90470aa6 merge from 3.2. Updates to http.client documentation. 2011-06-19 16:57:49 -07:00
Senthil Kumaran ce9b596c04 Fix closes Issue12315 - Updates to http.client documentation. 2011-06-19 16:56:49 -07:00
Senthil Kumaran 8ae34b46c7 merge from 3.2 2011-06-19 13:56:56 -07:00
Senthil Kumaran a977acc0fe merge from 3.1 for issue issue12261. 2011-06-19 13:55:48 -07:00
Senthil Kumaran fe9230aac6 Fix closes issue12261 - Minor documention changes in the urllib.parse.rst 2011-06-19 13:52:49 -07:00
Éric Araujo e043b6bac7 Add missing documentation for packaging.pypi.base and .simple 2011-06-19 19:23:48 +02:00
Benjamin Peterson 12f2bffce1 merge heads 2011-06-19 09:38:02 -05:00
Benjamin Peterson defe6f61fe clarify 2011-06-19 09:37:18 -05:00
Victor Stinner 2510d9e8d9 faulthandler doc: the the => the 2011-06-19 16:07:20 +02:00
R David Murray 50ae84e727 merge #6771: fix docs: curses.wrapper is exposed as a function, not a module 2011-06-18 19:41:43 -04:00
R David Murray 409c32f47c #6771: fix docs: curses.wrapper is exposed as a function, not a module
Patch by July Tikhonov.
2011-06-18 19:34:12 -04:00
Benjamin Peterson 85198753f1 edit and rewrite 2011-06-17 19:54:52 -05:00
Benjamin Peterson 364cbb8ca4 merge 3.2 2011-06-16 18:50:21 -05:00
Benjamin Peterson a08eb73b4a update link to pycrypto (closes #12351) 2011-06-16 18:49:46 -05:00
Éric Araujo a1969e0cbf Merge wording change from 3.2 2011-06-15 17:51:05 +02:00
Éric Araujo 8ddf7c2d2b Minor wording improvement 2011-06-15 17:49:20 +02:00
Georg Brandl e10b5e1dbb Fix markup. 2011-06-14 21:09:55 +02:00
Vinay Sajip bf94b0f943 Merged documentation update for Formatter.formatTime. 2011-06-12 11:50:40 +01:00
Vinay Sajip cdc751720e Updated Formatter.formatTime documentation. 2011-06-12 11:44:28 +01:00
Vinay Sajip 95ebf0ef00 Merged documentation update for issue #12206. 2011-06-11 23:04:35 +01:00
Vinay Sajip 0aaa9e1d7b Issue #12206: documentation for LogRecord constructor updated re. the level argument. 2011-06-11 23:03:37 +01:00
Éric Araujo bc18532eee Branch merge 2011-06-11 19:56:09 +02:00
Éric Araujo 7ebadd5d8d Use correct directive to document one method 2011-06-11 03:27:03 +02:00
Vinay Sajip 89c00ce33a Updated Formatter.formatTime docs to indicate configuration via class attributes. 2011-06-10 19:05:16 +01:00