Éric Araujo
217607ecde
Remove outdated pointer to optparse ( fixes #11360 ).
...
The doc already points to argparse.
2011-08-26 16:38:40 +02:00
Éric Araujo
72dde45dc6
Document the "optional" argument of distutils’ Extension class
2011-08-26 00:45:18 +02:00
Georg Brandl
852eea20ef
Close #12838 : fix range() call.
2011-08-25 11:52:26 +02:00
Antoine Pitrou
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
Sandro Tosi
5f4ea28f49
merge with 3.2
2011-08-19 22:55:24 +02:00
Sandro Tosi
6a633bb878
fix description of \r; thanks to Thomas Waldmann from docs@
2011-08-19 22:54:50 +02:00
Sandro Tosi
e1043fc230
fix description of \r; thanks to Thomas Waldmann from docs@
2011-08-19 22:54:50 +02:00
Sandro Tosi
8e35cf0770
merge with 3.2
2011-08-19 18:40:56 +02:00
Sandro Tosi
2f394f6666
mention RFC1123 as origin of 4-year digit; thanks to John Haxby from docs@
2011-08-19 18:40:21 +02:00
Sandro Tosi
f693810f69
mention RFC1123 as origin of 4-year digit; thanks to John Haxby from docs@
2011-08-19 18:40:21 +02:00
Éric Araujo
85ce247726
Branch merge
2011-08-19 14:22:52 +02:00
Éric Araujo
57bee66c03
Branch merge
2011-08-19 14:22:28 +02:00
Éric Araujo
d1ca4f9dc6
Merge fixes for #12256 and typos from 3.2
2011-08-19 09:36:59 +02:00
Éric Araujo
355d48ad83
Typo
2011-08-19 09:28:46 +02:00
Éric Araujo
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
Eli Bendersky
17e92cf9a6
Merge from 3.2
...
Issue #12672 : remove confusing part of sentence in documentation
2011-08-19 06:31:10 +03:00
Eli Bendersky
f6854cb0f0
Issue #12672 : remove confusing part of sentence in documentation
2011-08-19 06:29:51 +03:00
Eli Bendersky
729a42f263
Issue #12672 : remove confusing part of sentence in documentation
2011-08-19 06:29:51 +03:00
Éric Araujo
87552785c3
Mark abc.abstractproperty as a property
2011-08-19 03:53:51 +02:00
Éric Araujo
4d71a66a01
Fix typo in command name
2011-08-19 03:44:36 +02:00
Éric Araujo
24d6cc6f4f
Merge 3.2
2011-08-19 03:19:36 +02:00
Éric Araujo
a2d26182e2
Fix instance I missed in 59f7bbe1236c ( #1626300 )
2011-08-19 03:12:38 +02:00
Éric Araujo
e197df06fb
Remove obsolete term + indicate how to find the program ( #1626300 ).
...
Suggested by Terry J. Reedy.
2011-08-19 02:30:15 +02:00
Éric Araujo
e8b7eb07e1
Link isinstance/issubclass to the ABC glossary entry ( #12256 )
2011-08-19 02:17:03 +02:00
Éric Araujo
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
Éric Araujo
fde9242631
Don’t use “arg” for “argument”
2011-08-19 01:30:26 +02:00
Éric Araujo
19f9b71ffe
Add a few missing source links from 2.7 and harmonize lib docs headers
2011-08-19 00:49:18 +02:00
Éric Araujo
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
Éric Araujo
5eada94163
Fix markup to get a target instead of a comment
2011-08-19 00:41:23 +02:00
Éric Araujo
889a7dcb3a
Fix a typo and touch up blank lines
2011-08-19 00:40:46 +02:00
Éric Araujo
6e7d0ba309
Add missing reST target for one section of this file
2011-08-19 00:39:57 +02:00
Éric Araujo
0519b09936
Avoid splitting a word between a link and text
2011-08-19 00:39:19 +02:00
Sandro Tosi
b51a3c9d22
merge with 3.2
2011-08-16 20:03:50 +02:00
Sandro Tosi
b2761186af
#12761 : fix wording of zlib license section
2011-08-16 20:03:11 +02:00
Sandro Tosi
f6b25b9e35
#12761 : fix wording of zlib license section
2011-08-16 20:03:11 +02:00
Éric Araujo
b389eec440
Move versionadded directive to the top level, as we do in other files
2011-08-16 19:10:24 +02:00
Éric Araujo
e5905a9413
Fix typo
2011-08-16 19:09:56 +02:00
Ezio Melotti
ae0cbde231
#12204 : merge with 3.2.
2011-08-15 14:28:46 +03:00
Ezio Melotti
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
Ezio Melotti
7ec7fc4c3b
#12725 : merge with 3.2.
2011-08-14 08:29:49 +03:00
Ezio Melotti
f42121f27e
#12725 : fix working. Patch by Ben Hayden.
2011-08-14 08:28:57 +03:00
Ezio Melotti
388c945e97
#12725 : fix working. Patch by Ben Hayden.
2011-08-14 08:28:57 +03:00
Nadeem Vawda
1c38546e49
Issue #12646 : Add an 'eof' attribute to zlib.Decompress.
...
This will make it easier to detect truncated input streams.
Also, make zlib's error messages more consistent.
2011-08-13 15:22:40 +02:00
Georg Brandl
96d237c40a
Update versions in LICENSE files.
2011-08-13 11:59:12 +02:00
Georg Brandl
1db1d14e11
Update pydoc topics and suspicious ignore.
2011-08-13 11:33:35 +02:00
Sandro Tosi
98d95a50c9
merge with 3.2
2011-08-13 00:40:08 +02:00
Sandro Tosi
7bf4363f77
let PySequence_Check me a link; thanks to tomo cocoa from docs@
2011-08-13 00:39:46 +02:00
Sandro Tosi
b90770d31b
merge with 3.2
2011-08-12 19:31:56 +02:00
Sandro Tosi
8a3b657f9e
it's 'rather than'; reported by James Bateman on docs@
2011-08-12 19:31:32 +02:00
Éric Araujo
14eba5fa41
Brench merge
2011-08-12 17:59:25 +02:00
Éric Araujo
28d39a0c08
Branch merge
2011-08-12 17:40:25 +02:00
Eli Bendersky
47fe5c0d51
Issue #12672 : fix code samples in extending/newtypes.html for PEP-7 compliance
2011-08-12 11:40:39 +03:00
Brian Curtin
49281076c1
Add doc for Py_RETURN_NOTIMPLEMENTED, added in #12724 .
2011-08-11 09:41:31 -05:00
Vinay Sajip
f0dda5f876
Closes #12718 : Merge documentation fix from 3.2.
2011-08-11 13:46:54 +01:00
Vinay Sajip
817495a631
Issue #12718 : Add documentation on using custom importers.
2011-08-11 13:45:48 +01:00
Éric Araujo
54dbfbd675
Fix directive markup
2011-08-10 21:43:13 +02:00
Éric Araujo
e9715b9001
Merge 3.2
2011-08-10 21:42:23 +02:00
Éric Araujo
d9d7bca6da
Use real word in English text (i.e. not code)
2011-08-10 04:19:03 +02:00
Benjamin Peterson
e451ec393f
merge heads
2011-08-09 16:16:33 -05:00
Benjamin Peterson
9aae3a8cf5
merge 3.2 ( #12719 )
2011-08-09 16:15:29 -05:00
Benjamin Peterson
77c4fd01dd
note mutating tp_dict is bad ( closes #12719 )
2011-08-09 16:07:01 -05:00
Raymond Hettinger
fcb393c018
Add support for unary plus and unary minus to collections.Counter()
2011-08-09 13:00:40 -07:00
Éric Araujo
19272beec9
Branch merge
2011-08-09 18:01:52 +02:00
Éric Araujo
da3f4ae34b
Branch merge
2011-08-09 18:01:38 +02:00
Georg Brandl
96598afac4
Merge with 3.2.
2011-08-08 21:45:24 +02:00
Georg Brandl
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
Éric Araujo
5c3f648c0c
Branch merge
2011-08-08 16:56:17 +02:00
Éric Araujo
54a1d05877
Branch merge
2011-08-08 16:56:00 +02:00
Éric Araujo
e4d5b8e646
Clean up shutil.disk_usage.
...
- Move a test from call time to define time
- Add the function name to __all__
- Improve docstring and docs
A few lines are now duplicated (named tuple definition and docstring)
but I think the end result reads better.
2011-08-08 16:51:11 +02:00
Sandro Tosi
1a41a4114c
#12709 : merge with 3.2
2011-08-08 16:38:47 +02:00
Sandro Tosi
db79e95195
#12709 : add error_callback argument to map_async documentation
2011-08-08 16:38:13 +02:00
Sandro Tosi
1e8d8fd01d
#10741 : merge with 3.2
2011-08-08 00:17:43 +02:00
Sandro Tosi
61baee0ee7
#10741 : add documentation for PyGILState_GetThisThreadState()
2011-08-08 00:16:54 +02:00
Sandro Tosi
c42a568cd4
#12677 : merge with 3.2
2011-08-07 17:13:13 +02:00
Sandro Tosi
2a389e4601
#12677 : correct turtle orientation in doc
2011-08-07 17:12:19 +02:00
Éric Araujo
7dc76fdeb1
Merge doc changes from 3.2 ( #8617 , #10745 ).
...
In the install and library docs, I changed the text to refer to
packaging instead of distutils. I also checked that the documented
paths correctly reflect what’s really defined in sysconfig; the main
difference with paths defined in distutils.install is that include
directories don’t end with the distribution name anymore (i.e. distutils
uses include/python3.3/spam, sysconfig include/python3.3), I have no
idea why.
2011-08-06 16:58:15 +02:00
Éric Araujo
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
Eli Bendersky
de8c100ef0
Fix grammar
2011-08-06 09:32:11 +03:00
Eli Bendersky
ebd4805df0
Fix grammar
2011-08-06 09:31:09 +03:00
Senthil Kumaran
31c2e37ea8
merge from 3.2 - Fix closes Issue12697 - Update the usage syntax of timeit module in the docs.
2011-08-06 13:37:37 +08:00
Senthil Kumaran
2e0153550c
Fix closes Issue12697 - Update the usage syntax of timeit module in the docs.
2011-08-06 13:37:04 +08:00
Senthil Kumaran
ef94203439
merge from 3.2 - Fix closes issue11047 - Correct the 2.7 whatsnew description for issue 7902.
2011-08-06 12:55:06 +08:00
Senthil Kumaran
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
É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
Éric Araujo
7dfdac0b5a
Branch merge
2011-08-01 14:44:17 +02:00
Éric Araujo
2ffea0e8d7
Branch merge
2011-08-01 14:43:45 +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
Ezio Melotti
e906c13da4
Merge typo fix.
2011-07-31 22:50:01 +03:00
Ezio Melotti
222e61e444
Fix typo reported by Sandro Tosi.
2011-07-31 22:49:18 +03:00
Éric Araujo
ad548b8534
Merge fixes for #9860 , #11104/#8688 and #12331 from 3.2
2011-07-31 18:33:00 +02:00
Éric Araujo
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
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
Ezio Melotti
6e3b975aa5
#12531 : merge with 3.2.
2011-07-30 21:26:40 +03:00
Ezio Melotti
592563292c
#12531 : Fix spaces and markup.
2011-07-30 21:25:22 +03: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
Eli Bendersky
6e5b2ac400
Merge from 3.2: Issue #12531 : add index entries to documentation of * and ** in function calls
2011-07-30 07:07:29 +03:00
Eli Bendersky
7bd081c117
Issue #12531 : add index entries to documentation of * and ** in function calls
2011-07-30 07:05:16 +03: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
Eli Bendersky
906b88fb2a
Issue #12380 : PyArg_ParseTuple now accepts a bytearray for the 'c' format.
...
As a side effect, this now allows the rjust, ljust and center methods of
bytes and bytearray to accept a bytearray argument.
Patch by Petri Lehtinen
2011-07-29 07:05:08 +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
cdb31093c2
Fix reST role and missing word
2011-07-28 23:10:25 +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
f5e10d1f70
Turn raw URI into real link
2011-07-28 22:50:18 +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
72db3459e4
Make indentation comply with our style guide and the rest of the file
2011-07-26 16:54:24 +02:00
Éric Araujo
59e387eb40
Fix “anyways” (following R. David Murray in 4d5a546b6186)
2011-07-26 16:53:17 +02:00
Éric Araujo
7c12bae717
Fix reST references
2011-07-26 15:14:35 +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
Georg Brandl
deb852db71
Merge 3.2 branch.
2011-07-23 08:06:00 +02:00
Georg Brandl
06ad13ee7c
Fix function name: open -> urlopen.
2011-07-23 08:04:40 +02:00
Ezio Melotti
bca31b5d1f
#11435 : link to the correct branch.
2011-07-21 09:35:19 +03:00