3a8501e71f
Closes issue 12767: document the argument of threading.Condition.notify
2011-11-12 20:51:54 +02:00
a203cedf44
Issue #12875 : explicitly specify default value of the optional 'flags' argument to re.* functions. Closes #12875
2011-11-11 21:25:56 +02:00
bba1dd5332
Issue #13191 : typo in argparse docs
2011-11-11 16:42:11 +02:00
5df091a91e
Closes issue #13353 : version doumentation about utc parameter corrected.
2011-11-06 22:37:17 +00:00
972ba9e41f
Add missing versionadded ( fixes #12392 )
2011-11-05 17:55:03 +01:00
416ecffcc4
Issue #3067 : Enhance the documentation and docstring of locale.setlocale()
2011-11-05 10:18:50 +02:00
5d19b9a1e8
Fix typos
2011-11-04 14:05:52 -07:00
23ca12a981
Inline the advisory text on how to use the shelve module.
2011-11-04 13:07:52 -07:00
0fc13ae345
Fix Issue13147 - Correct the Multiprocessing Pool.map_async method signature.
...
Remove the error_callback which is not present in 2.7. Patch by Jyrki
Pulliainen.
2011-11-03 02:02:38 +08:00
7e82b276dd
#670664 : Fix HTMLParser to correctly handle the content of ``<script>...</script>`` and ``<style>...</style>``.
2011-11-01 14:09:56 +02:00
1f3b84f971
correct signature for tzinfo.dst() in examples; thanks to Daniil Shved from docs@
2011-11-01 10:31:26 +01:00
a9db763cc0
document turtle mainloop()/done() functions; thanks to Csaba Szepesvari from docs@
2011-10-31 10:08:14 +01:00
187aa269c2
Improve itertools docs with clearer examples of pure python equivalent code.
2011-10-30 14:53:17 -07:00
87033526ad
Minor fixes to the HTMLParser doc.
2011-10-28 14:20:08 +03:00
f9cc80d601
Improve HTMLParser example in the doc.
2011-10-28 14:14:34 +03:00
24c51809cf
#13278 : fix typo.
2011-10-28 12:22:25 +03:00
87ba642ce6
Issue #13237 : Make the subprocess convenience helper documentation self-contained aside from the shared parameter description. Downgrade the pipe warnings at that level to notes (since those pipes are hidden, people are unlikely to even try it)
2011-10-27 17:55:13 +10:00
63c54e819e
Issue #13237 : fix typo
2011-10-26 21:34:26 +10:00
65ad31a8f8
Issue #13237 : remove some details that only apply to the 3.x version of this module and cross reference the relocated warning about the dangers of invoking the shell with untrusted input
2011-10-26 21:15:53 +10:00
2ed203af87
Issue #13237 : further updates to subprocess documentation
2011-10-26 21:05:56 +10:00
59b13f4de9
Refactor a bit the codecs doc.
2011-10-25 10:46:22 +03:00
22dabb6ffa
merge heads
2011-10-24 08:51:46 -04:00
414ffa86b5
note callable is back in 3.2
2011-10-24 08:51:15 -04:00
8671157863
Issue #13237 : Rearrange subprocess module documentation to emphasise the convenience functions and commonly needed arguments
2011-10-24 22:19:40 +10:00
df10d7cb97
Issue #13141 : Demonstrate recommended style for SocketServer examples.
2011-10-23 23:07:22 +02:00
b21f51a9d0
Note that the #1548891 fix indirectly fixes shlex ( #6988 , #1170 )
2011-10-23 04:37:51 +02:00
5a77fe92bd
Issue #1548891 : The cStringIO.StringIO() constructor now encodes unicode
...
arguments with the system default encoding just like the write() method
does, instead of converting it to a raw buffer.
2011-10-22 21:26:01 +02:00
5e30fa5f56
#13233 : fix typo.
2011-10-20 19:49:29 +03:00
a1958734cb
#13219 : clarify section about character sets in the re documentation.
2011-10-20 19:31:08 +03:00
ddd40312d5
Fix closes Issue6090 - Raise a ValueError, instead of failing with unrelated
...
exceptions, when a document with timestamp earlier than 1980 is provided to
zipfile. Patch contributed by Petri Lehtinen.
2011-10-20 01:38:35 +08:00
1e87da16ea
Remove duplication.
2011-10-19 10:39:35 +03:00
086f927f25
#12277 : add missing comma.
2011-10-18 13:02:11 +03:00
c54d97b961
#13138 : add missing versionadded. Patch by Andreas Stührk.
2011-10-09 23:56:51 +03:00
3e0a3faaa2
Clean-up and improve the priority queue example in the heapq docs.
2011-10-09 17:32:43 +01:00
eb35f25412
Fix a typo and a broken link (part of #10536 ).
...
Found by Franz Glasner in #2504 .
2011-10-08 02:15:04 +02:00
5472c1c004
Issue #12823 : remove broken link and replace it with another resource.
2011-10-07 17:03:01 +02:00
e954ecb9ba
Branch merge
2011-10-06 13:19:34 +02:00
41d663f0a5
Issue13073 - Address review comments and add versionchanged information in the docs.
2011-10-05 23:52:49 +08:00
2e4a2b6434
Fix markup used in the documentation of sys.prefix and sys.exec_prefix.
...
- Using the file role with {placeholders} is IMO clearer than fake
Python code.
- The fact that sys.version[:3] gives '2.7' is a CPython detail and
should not be advertised (see #9442 ), even if some stdlib modules
currently rely on that detail.
2011-10-05 02:34:28 +02:00
656b04ecf6
Move doc of sys.dont_write_bytecode to make all attributes sorted again
2011-10-05 02:25:58 +02:00
83cc512a01
update 2.7 - Document message_body arg in HTTPConnection.endheaders
2011-10-03 07:37:58 +08:00
f17e405eb7
#13076 : fix links to datetime.time.
2011-10-02 12:22:13 +03:00
607cc361bb
Fix bug in heapq priority queue example.
2011-09-18 07:40:05 +02:00
21c69b1043
Add info from the docstring for random.gammavariate() to the docs.
2011-09-17 20:36:28 +02:00
d99ff29cf9
Update sys.platform doc for #12326 .
...
Backport from Python 3.2 (e11b4c945f7e).
2011-09-05 22:33:55 +02:00
9541f8eb2b
merge from 3.2. Fix closes Issue11155 - Correct the multiprocessing.Queue.put's arg (replace 'item' with 'obj') in the docs. Patch by Westley Martínez.
2011-09-06 00:23:10 +08:00
a95d19efa6
#12781 : Mention SO_REUSEADDR flag near socket examples
2011-09-02 20:04:20 +02:00
b71c15d407
Branch merge
2011-09-02 17:33:10 +02:00
cd90f79125
Document that format string don’t support arbitrary dictonary keys.
...
Text adapted from the PEP. Addition requested by Terry J. Reedy on
2011-02-23 on python-dev.
2011-09-01 19:57:01 +02:00
7ce05e07c0
Fix some markup and one typo
2011-09-01 19:54:05 +02:00
a7cbe28bcc
Avoid using the default reST role. Makes Doc/tools/rstlint.py happy.
2011-09-01 19:49:31 +02:00
4f14a1ff52
From RFC 3629 5- and 6-bytes UTF-8 sequences are invalid, so remove them from the doc.
2011-09-01 08:19:01 +03:00
9bfc16a99e
added versionadd information for pkgutil.get_data(); thanks to Kyle Monson from docs@
2011-08-30 19:40:28 +02:00
0f697b300c
Remove outdated pointer to optparse ( fixes #11360 ).
...
The doc already points to argparse.
2011-08-26 16:38:40 +02:00
b384356b9b
Issue #12213 : make it clear that BufferedRWPair shouldn't be called with the
...
same object as reader and writer, and deemphasize it in document order.
2011-08-20 19:51:31 +02:00
9b68092d1d
#12787 : link original MultiCall proposal to webarchive and in a footnote
2011-08-20 17:05:15 +02:00
a7eb3c802e
fix description of \r; thanks to Thomas Waldmann from docs@
2011-08-19 22:54:33 +02:00
da5a9622f1
merge heads
2011-08-19 18:43:43 +02:00
657a7fcb95
mention RFC1123 as origin of 4-year digit; thanks to John Haxby from docs@
2011-08-19 18:39:35 +02:00
e0054c51c7
Link isinstance/issubclass to the ABC glossary entry ( #12256 )
2011-08-19 09:15:47 +02:00
f06568cbd8
Fix a typo and remove some unneeded markup
2011-08-19 09:00:56 +02:00
e68d4504fd
Add documentation for PEP 370 features in distutils ( #10745 ).
...
Apart from adding a section to describe the user scheme, this changeset
also does some much needed cleanup:
- fixed inverted reST targets
- fixed some paths
- avoided duplicating the same options listing five or six times
- added missing entries for C headers locations
- added documentation for --install-lib
- fixed a few misuses of the option role (see #9312 ), but not all (not
worth the time, but will do it in packaging docs)
- fixed some markup
The paths fixes were done with an eye on the source code in the install
command, so they really describe what’s actually done. The situation on
Mac OS X is rather messy: the fix for #8084 touched site and sysconfig,
but distutils does not use these files anymore since the Great Revert.
I suspect we have a mismatched stdlib at the moment, and the fix is not
even clear (see discussion on #8084 ).
2011-08-19 08:34:52 +02:00
afd2fe2aea
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 is also 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-19 08:20:01 +02:00
99c4c340e6
Add missing documentation for logger argument of shutil.make_archive
2011-08-19 02:51:17 +02:00
bd858b75ce
Turn last automatic footnote in this file into a manually-numbered one
2011-08-19 02:28:40 +02:00
cdb86f17bf
Branch merge
2011-08-19 02:26:44 +02:00
29a0b57e4e
Backport source links from 3.x.
...
Existing links have been updated to use the new reST role. In some
files, I have also made cosmetic changes to the header.
2011-08-19 02:14:03 +02:00
d478a46d56
Use standard heading for ast module docs
2011-08-19 02:01:14 +02:00
67719bde07
Synchronize argparse docs with 3.x versions
2011-08-19 02:00:07 +02:00
d9aeb60465
Remove unneeded reST target
2011-08-19 01:47:48 +02:00
5085e8ac67
#12204 : document that str.upper().isupper() might be False and add a note about cased characters.
2011-08-15 14:24:15 +03:00
ca5e908c6e
#12725 : fix working. Patch by Ben Hayden.
2011-08-14 08:27:36 +03:00
569ff91a5a
Avoid title case in flowing text (backport from 3.2)
2011-08-13 02:47:38 +02:00
c67975beea
it's 'rather than'; reported by James Bateman on docs@
2011-08-12 19:31:15 +02:00
71a5ea0a9b
English fixup, from Mike MacCana on docs@
2011-08-12 19:11:24 +02:00
5088b504be
Issue #12718 : Add documentation on using custom importers.
2011-08-11 13:39:52 +01:00
ea75f4cf3b
Fix closes Issue12722 - link heapq source in the text format in the documentation.
2011-08-10 21:54:56 +08:00
a9c9b2c38c
#12709 : add error_callback argument to map_async documentation
2011-08-08 16:37:44 +02:00
1381a31e39
#12677 : correct turtle orientation in doc
2011-08-07 17:09:15 +02:00
e11af59e2a
Fix grammar
2011-08-06 09:29:12 +03:00
b8b71725c3
Fix closes Issue12697 - Update the usage syntax of timeit module in the docs.
2011-08-06 13:34:30 +08:00
c1ee4ef9dc
Fix closes issue12663 - Correcting the ArgumentParser.error description. Patch by Sandro Tosi.
2011-08-03 07:43:52 +08:00
25fb852e55
#12670 : Fix struct code after forward declaration on ctypes doc
2011-08-02 16:16:11 +02:00
22a7b488e0
Fix closes Issue12183 - Explain the Symlink copy behavior in shutil.copytree. Patch by Petri Lehtinen.
2011-08-02 18:50:44 +08:00
93d3a8d67c
Use attribute access instead of index access for namedtuple.
2011-08-01 22:58:53 +02:00
5d09ba46c9
Closes #12667 : Corrected documentation for SMTPHandler secure argument.
2011-08-01 11:28:02 +01:00
35fd1b9107
be precise
2011-07-30 22:08:09 -05:00
110b781129
note Ellipsis syntax
2011-07-30 09:59:12 -05:00
6726af73de
add space
2011-07-30 09:58:59 -05:00
f444f94ed2
document NotImplemented
2011-07-30 09:57:24 -05:00
dedb502f90
Issue #11699 : fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen
2011-07-30 11:12:45 +03:00
43162e22c5
Document that atexit execution order is undefined ( #9788 )
2011-07-29 18:04:24 +02:00
f0d44bccb7
Add a link target for argparse.Namespace ( #8982 )
2011-07-29 17:59:17 +02:00
d01aebe3d6
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-29 12:10:53 +02:00
2e1c294d28
Fix “anyways” (following R. David Murray in 5c7520e02d5a)
2011-07-29 11:57:50 +02:00
ad84ea11c2
Add links from builtins module docs to built-in functions and constants docs
2011-07-29 11:53:57 +02:00
5dd034b84f
Minor doc addition for clarity
2011-05-27 04:42:47 +02:00
8fde9506b7
Improve glossary entry for ABCs.
...
- Rename reST target name for collections ABCs to avoid collisions
- Link to glossary entry from numbers module doc (other modules already do it)
2011-07-29 11:34:17 +02:00
beb9170cc4
Merge #12417 followup, also removing an extra docstring
2011-07-28 22:32:04 +02:00
345fff3de8
Remove mentions of previous license in profile module ( #12417 followup)
2011-07-28 22:27:28 +02:00
Eli Bendersky
Vinay Sajip
Éric Araujo
Petri Lehtinen
Raymond Hettinger
Senthil Kumaran
Ezio Melotti
Sandro Tosi
Nick Coghlan
Benjamin Peterson
Florent Xicluna
Antoine Pitrou
Georg Brandl
Victor Stinner