bb2095f1e2
Branch merge
2011-10-06 13:10:34 +02:00
ad87fa6719
Issue #13073 - Address the review comments made by Ezio.
2011-10-05 23:26:49 +08:00
58a9153c9f
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 '3.2' is a CPython detail and
should not be advertised (see #9442 ), even if some stdlib modules
currently rely on that detail.
2011-10-05 01:28:24 +02:00
da27263b4a
Move doc of sys.dont_write_bytecode to make all attributes sorted again
2011-10-05 01:17:38 +02:00
5d0de3fbaa
Document message_body arg in HTTPConnection.endheaders
2011-10-03 07:27:06 +08:00
35ec7f771b
#13076 : fix links to datetime.time and datetime.datetime.
2011-10-02 12:44:50 +03:00
17dac4c0e2
Fix closes issue13005 - Remove the mention of 'repeat' method in the operator module documentation.
2011-09-22 02:09:17 +08:00
1d678f8413
Fix bug in heapq priority queue example.
2011-09-18 07:40:05 +02:00
73dd7c71f6
Add info from the docstring for random.gammavariate() to the docs.
2011-09-17 20:36:28 +02:00
755460694e
Fix typo.
2011-09-17 20:20:04 +02:00
4165bfb6e9
#12940 : fix cmd example. Patch by Tim Chase.
2011-09-10 10:06:01 +03:00
eb933de807
Fix current name of the Python 3 binary on Unix ( #12896 ).
...
Also fix some markup and typos.
2011-09-09 19:03:41 +02:00
4eb0e73ff2
Closes #12906 : Fixed bug in YAML configuration.
2011-09-06 14:07:23 +01:00
e969a2117c
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:21:30 +08:00
3484a8771c
Merge with release clone.
2011-09-04 08:35:54 +02:00
7335e6f3e8
removed misleading editing leftovers
2011-09-02 23:17:39 +02:00
fbd4fe2195
Give credit to Adam
2011-09-02 21:24:40 +02:00
172f374a63
#12781 : Mention SO_REUSEADDR flag near socket examples
2011-09-02 20:06:31 +02:00
d9e1789364
Branch merge
2011-09-02 17:30:36 +02:00
18ddf826e7
Add links from library/functions to other docs.
...
Suggested by Terry J. Reedy in #12298 .
2011-09-01 23:10:36 +02:00
9edd9f035b
Fix a few links in the table of built-in functions ( #12298 )
2011-09-01 23:08:55 +02:00
29cf58c9d5
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 18:59:06 +02:00
8ab3a1d735
Document that True/False/None don’t use :keyword: in doc.
...
This was discussed some months ago on python-dev. Having tons of links
to the definition of True would be annoying, contrary to links to e.g.
the nonlocal or with statements doc.
2011-09-01 18:45:50 +02:00
222b20844f
From RFC 3629 5- and 6-bytes UTF-8 sequences are invalid, so remove them from the doc.
2011-09-01 08:11:28 +03:00
a9353db2cd
Remove duplicate text in os documentation.
2011-09-01 06:58:52 +02:00
ec9a5f6399
Add version number for versionchanged directive (backport from 3.3)
2011-09-01 05:55:26 +02:00
7af8ebb6ce
Adapt/remove mentions of functions gone in 3.x
2011-09-01 03:20:13 +02:00
37b5f9eebc
Fix some misuses of Sphinx roles and one typo
2011-09-01 03:19:30 +02:00
941afedd74
Avoid using the default reST role. Makes Doc/tools/rstlint.py happy.
2011-09-01 02:47:34 +02:00
be573e7d17
Remove outdated pointer to optparse ( fixes #11360 ).
...
The doc already points to argparse.
2011-08-26 16:38:40 +02:00
77443824f5
Document the "optional" argument of distutils’ Extension class
2011-08-26 00:45:18 +02:00
3f5e958a3f
Fix type information in distutils API reference ( #9302 ).
...
Initial patch by Yue Shuaijie.
2011-08-26 00:44:37 +02:00
cc42ebe450
Make the list of docs contributors sorted again
2011-08-26 00:10:12 +02:00
e1eef41a18
Close #12838 : fix range() call.
2011-08-25 11:52:26 +02:00
13d2895dbf
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:48:43 +02:00
9daf98d32a
#12787 : link original MultiCall proposal to webarchive and in a footnote
2011-08-20 17:05:56 +02:00
2513123d66
Update suspicious ignore file.
2011-09-03 09:28:05 +02:00
a47e53e42e
Update sys.platform doc for #12326 .
2011-09-03 09:26:09 +02:00
987b188615
removed misleading editing leftovers
2011-09-02 23:17:39 +02:00
335f204977
#12781 : Mention SO_REUSEADDR flag near socket examples
2011-09-02 20:06:31 +02:00
d86ac4cd4e
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 18:59:06 +02:00
7bb769c092
Add version number for versionchanged directive (backport from 3.3)
2011-09-01 05:55:26 +02:00
f3c7822ee5
Adapt/remove mentions of functions gone in 3.x
2011-09-01 03:20:13 +02:00
43ba354599
Fix some misuses of Sphinx roles and one typo
2011-09-01 03:19:30 +02:00
217607ecde
Remove outdated pointer to optparse ( fixes #11360 ).
...
The doc already points to argparse.
2011-08-26 16:38:40 +02:00
72dde45dc6
Document the "optional" argument of distutils’ Extension class
2011-08-26 00:45:18 +02:00
852eea20ef
Close #12838 : fix range() call.
2011-08-25 11:52:26 +02:00
dc42beb55e
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:48:43 +02:00
6a633bb878
fix description of \r; thanks to Thomas Waldmann from docs@
2011-08-19 22:54:50 +02:00
e1043fc230
fix description of \r; thanks to Thomas Waldmann from docs@
2011-08-19 22:54:50 +02:00
2f394f6666
mention RFC1123 as origin of 4-year digit; thanks to John Haxby from docs@
2011-08-19 18:40:21 +02:00
f693810f69
mention RFC1123 as origin of 4-year digit; thanks to John Haxby from docs@
2011-08-19 18:40:21 +02:00
57bee66c03
Branch merge
2011-08-19 14:22:28 +02:00
355d48ad83
Typo
2011-08-19 09:28:46 +02:00
04ac59a22a
Mention virtual subclasses in the glossary entry for ABCs ( #12256 ).
...
I added a link from the term “virtual subclass” to the glossary entry
for ABCs but this was not enough, now the glossary briefly defines
“virtual” and links to the abc module doc which contains more mentions
of virtual subclasses.
2011-08-19 09:07:46 +02:00
f6854cb0f0
Issue #12672 : remove confusing part of sentence in documentation
2011-08-19 06:29:51 +03:00
729a42f263
Issue #12672 : remove confusing part of sentence in documentation
2011-08-19 06:29:51 +03:00
4d71a66a01
Fix typo in command name
2011-08-19 03:44:36 +02:00
a2d26182e2
Fix instance I missed in 59f7bbe1236c ( #1626300 )
2011-08-19 03:12:38 +02:00
e197df06fb
Remove obsolete term + indicate how to find the program ( #1626300 ).
...
Suggested by Terry J. Reedy.
2011-08-19 02:30:15 +02:00
e8b7eb07e1
Link isinstance/issubclass to the ABC glossary entry ( #12256 )
2011-08-19 02:17:03 +02:00
543edbdab8
Don’t quote characters twice.
...
``code`` markup is enough to mark command-line fragments or to talk
about a character. ``'c'`` is still used for actual Python string
objects. I did a similar change in optparse.rst in r86521.
I’ve also ported two minor changes from the 3.3 version of the file
(removing an unnecessary module name in a class directive, adding a
comma).
2011-08-19 01:45:12 +02:00
fde9242631
Don’t use “arg” for “argument”
2011-08-19 01:30:26 +02:00
19f9b71ffe
Add a few missing source links from 2.7 and harmonize lib docs headers
2011-08-19 00:49:18 +02:00
d001ffe745
Minor improvements to BadZipFile and BadZipfile docs.
...
I made the doc for the compat alias BadZipfile shorter and used a
directive to document deprecation.
I figured there was no point of talking about zipfile.error (“the old
name” that’s older than the other old name BadZipfile) in the 3.x docs
so I just removed it.
2011-08-19 00:44:31 +02:00
5eada94163
Fix markup to get a target instead of a comment
2011-08-19 00:41:23 +02:00
889a7dcb3a
Fix a typo and touch up blank lines
2011-08-19 00:40:46 +02:00
6e7d0ba309
Add missing reST target for one section of this file
2011-08-19 00:39:57 +02:00
0519b09936
Avoid splitting a word between a link and text
2011-08-19 00:39:19 +02:00
b2761186af
#12761 : fix wording of zlib license section
2011-08-16 20:03:11 +02:00
f6b25b9e35
#12761 : fix wording of zlib license section
2011-08-16 20:03:11 +02:00
0656a56214
#12204 : document that str.upper().isupper() might be False and add a note about cased characters.
2011-08-15 14:27:19 +03:00
f42121f27e
#12725 : fix working. Patch by Ben Hayden.
2011-08-14 08:28:57 +03:00
388c945e97
#12725 : fix working. Patch by Ben Hayden.
2011-08-14 08:28:57 +03:00
96d237c40a
Update versions in LICENSE files.
2011-08-13 11:59:12 +02:00
1db1d14e11
Update pydoc topics and suspicious ignore.
2011-08-13 11:33:35 +02:00
7bf4363f77
let PySequence_Check me a link; thanks to tomo cocoa from docs@
2011-08-13 00:39:46 +02:00
8a3b657f9e
it's 'rather than'; reported by James Bateman on docs@
2011-08-12 19:31:32 +02:00
28d39a0c08
Branch merge
2011-08-12 17:40:25 +02:00
817495a631
Issue #12718 : Add documentation on using custom importers.
2011-08-11 13:45:48 +01:00
d9d7bca6da
Use real word in English text (i.e. not code)
2011-08-10 04:19:03 +02:00
77c4fd01dd
note mutating tp_dict is bad ( closes #12719 )
2011-08-09 16:07:01 -05:00
da3f4ae34b
Branch merge
2011-08-09 18:01:38 +02:00
bdbdfb1978
Confirm that the prime example is actually correct. We get so many complaints about a "buggy example" on docs@python, let us hope this cuts them in half at least.
2011-08-08 21:45:13 +02:00
54a1d05877
Branch merge
2011-08-08 16:56:00 +02:00
db79e95195
#12709 : add error_callback argument to map_async documentation
2011-08-08 16:38:13 +02:00
61baee0ee7
#10741 : add documentation for PyGILState_GetThisThreadState()
2011-08-08 00:16:54 +02:00
2a389e4601
#12677 : correct turtle orientation in doc
2011-08-07 17:12:19 +02:00
6ef038e78c
Add documentation for PEP 370 features in distutils ( #10745 ).
...
This started out as an easy task, just add a section describing this
alternate scheme, but I found a lot of cleanup to do along the way:
- fixed inverted reST targets
- fixed entries for modules (hi abiflags!) or data files
- 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 doesn’t use these files. I suspect we have a mismatched
stdlib at the moment, and the fix is not even clear (see the bug report
for further discussion).
2011-08-06 16:30:42 +02:00
ebd4805df0
Fix grammar
2011-08-06 09:31:09 +03:00
2e0153550c
Fix closes Issue12697 - Update the usage syntax of timeit module in the docs.
2011-08-06 13:37:04 +08:00
a3b2316a1b
merge from 2.7 - Fix closes issue11047 - Correct the 2.7 whatsnew description for issue 7902.
2011-08-06 12:54:23 +08:00
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
86a1a8974d
Fix closes issue12663 - Correcting the ArgumentParser.error description. Patch by Sandro Tosi.
2011-08-03 07:42:18 +08:00
2a8d195328
#12665 : Dictionary view example has error in set operation
2011-08-02 18:42:04 +02:00
692dba244b
#12670 : Fix struct code after forward declaration on ctypes doc
2011-08-02 16:17:14 +02:00
ef5c716176
Fix closes Issue12183 - Explain the Symlink copy behavior in shutil.copytree. Patch by Petri Lehtinen.
2011-08-02 18:52:28 +08:00
aa71583f09
Use attribute access instead of index access for namedtuple.
2011-08-01 22:58:53 +02:00
2ffea0e8d7
Branch merge
2011-08-01 14:43:45 +02:00
952595696a
Closes #12667 : Added documentation for SMTPHandler secure argument.
2011-08-01 11:31:52 +01:00
222e61e444
Fix typo reported by Sandro Tosi.
2011-07-31 22:49:18 +03:00
ab7c1b3f11
Fix regression with distutils MANIFEST handing ( #11104 , #8688 ).
...
The changed behavior of sdist in 3.1 broke packaging for projects that
wanted to use a manually-maintained MANIFEST file (instead of having a
MANIFEST.in template and letting distutils generate the MANIFEST).
The fixes that were committed for #8688 (76643c286b9f by Tarek and
d54da9248ed9 by me) did not fix all issues exposed in the bug report,
and also added one problem: the MANIFEST file format gained comments,
but the read_manifest method was not updated to handle (i.e. ignore)
them. This changeset should fix everything; the tests have been
expanded and I successfully tested the 2.7 version with Mercurial, which
suffered from this regression.
I have grouped the versionchanged directives for these bugs in one place
and added micro version numbers to help users know the quirks of the
exact version they’re using.
Initial report, thorough diagnosis and patch by John Dennis, further
work on the patch by Stephen Thorne, and a few edits and additions by
me.
2011-07-31 04:06:12 +02:00
592563292c
#12531 : Fix spaces and markup.
2011-07-30 21:25:22 +03:00
497cd65cec
add space
2011-07-30 09:59:50 -05:00
50211fa0f9
document NotImplemented
2011-07-30 09:57:24 -05:00
b603b27775
merging Georg's revision
2011-07-30 11:36:41 +03:00
e250358062
Issue #11699 : fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen
2011-07-30 11:14:32 +03:00
eea6cda91a
Change test.support docs to be more specific about the nature of this module.
2011-07-30 09:00:48 +02:00
7bd081c117
Issue #12531 : add index entries to documentation of * and ** in function calls
2011-07-30 07:05:16 +03:00
fe1e298d8b
Document that atexit execution order is undefined ( #9788 )
2011-07-29 18:04:24 +02:00
63b18a4445
Add a link target for argparse.Namespace ( #8982 )
2011-07-29 17:59:17 +02:00
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
158d7696f3
Branch merge
2011-07-29 14:24:08 +02:00
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
cf534817ad
Branch merge
2011-07-28 23:08:11 +02:00
fc662ddda2
Merge profile docs followup ( #12417 ) from 3.1
2011-07-28 23:00:14 +02:00
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
f5e10d1f70
Turn raw URI into real link
2011-07-28 22:50:18 +02:00
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
72db3459e4
Make indentation comply with our style guide and the rest of the file
2011-07-26 16:54:24 +02:00
59e387eb40
Fix “anyways” (following R. David Murray in 4d5a546b6186)
2011-07-26 16:53:17 +02:00
7c12bae717
Fix reST references
2011-07-26 15:14:35 +02:00
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
06ad13ee7c
Fix function name: open -> urlopen.
2011-07-23 08:04:40 +02:00
bca31b5d1f
#11435 : link to the correct branch.
2011-07-21 09:35:19 +03:00
96c84a4c7d
Fix closes issue12524 - update http.client POST example with a working example.
2011-07-20 21:56:24 +08:00
ae4a78b0a8
Fix closes issue12577 - clarify shutil.move documentation. Patch suggestion by Catalin Iacob
2011-07-19 08:03:02 +08:00
0e752dd3f8
Issue #6476 : Document that os.spawnle and os.spawnve are not thread-safe under Windows.
2011-07-19 01:26:58 +02:00
b899007268
Better English.
2011-07-18 12:38:03 -04:00
3e7f33fc82
fix whitespace nit.
2011-07-18 07:17:20 +08:00
0215d09ca9
Fix closes Issue12478 - HTTPErrorProcess 's methods are http_response and https_response.
2011-07-18 07:12:40 +08:00
ed270fab64
Fix closes Issue12479 - Add HTTPErrorProcessor class definition - Patch by Sandro Tosi
2011-07-18 06:42:46 +08:00
023c6f703d
Fix Issue10403 - datetime documentation clarification based on review in the reitveld by Alexendar belopolsky.
2011-07-17 19:01:14 +08:00
ad3882a2b0
Fix closes Issue11436 - Minor clarification to struct documentation for 's' format character.
2011-07-17 17:29:17 +08:00
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
fd060474e3
Make it clear that PyNumber_AsSsize_t() returns -1 on error.
2011-07-13 21:02:22 +02:00
325eb470b7
Clarify that PyErr_NewException creates an exception *class*, not instance.
2011-07-13 15:59:24 +02:00
b3593cada2
Use infinitive, not 3rd person of present tense.
2011-07-11 01:39:19 +02:00
6f5dcb1ee2
Issue #12343 : Add some notes on behaviour of non-blocking SSL sockets.
2011-07-11 01:35:48 +02:00
cdddf2b875
Mention logging.captureWarnings in the warnings module doc.
2011-07-09 21:29:36 +02:00
462d1b39a4
Move sys.subversion at the right place in alphabetical order, and informally deprecate it.
2011-07-09 16:02:19 +02:00
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
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
3aac179498
Fix whitespace nit in datetime and os rst files.
2011-07-04 11:43:51 -07:00
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
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
946eb865a3
reST indentation fix in sqlite3 docs. rst uses 3 space indentation.
2011-07-03 10:17:22 -07:00
f069100d0d
Fix bad markup.
2011-07-03 09:39:49 +02:00
7f3cd98beb
Fix target path in message.
2011-07-03 09:30:42 +02:00
40d9ebe031
Issue #12228 : Fix exchanged flag descriptions in stat.rst. Thanks Sandro Tosi.
2011-06-25 12:03:33 +02:00
Éric Araujo
Senthil Kumaran
Ezio Melotti
Georg Brandl
Vinay Sajip
Łukasz Langa
Sandro Tosi
Ross Lagerwall
Antoine Pitrou
Eli Bendersky
Benjamin Peterson
R David Murray
Ned Deily
Victor Stinner
Mark Dickinson