388349add2
Closes #12192 : Document that mutating list methods do not return the instance (original patch by Mike Hoy).
2011-10-08 18:32:40 +02:00
a29e4f64c1
Fix packaging byte-compilation to comply with PEP 3147 ( #11254 ).
...
I want to replace custom byte-compiling function with calls to
compileall before 3.3b1, but in the short term it’s good to have this
fixed.
Adapted from the distutils patch by Jeff Ramnani. I tested with -B, -O
and -OO; test_util and test_mixin2to3 fail in -O mode because lib2to3
doesn’t support it.
2011-10-08 04:09:15 +02:00
6ebea15e0b
Merge fixes for #10526 , #10359 , #11254 , #9100 and the bug without number
2011-10-08 02:57:45 +02:00
35a502b324
Fix a typo and a broken link (part of #10536 ).
...
Found by Franz Glasner in #2504 .
2011-10-07 22:02:58 +02:00
756b169c5a
Issue #12823 : remove broken link and replace it with another resource.
2011-10-07 16:58:35 +02:00
f394e47851
Issue #12823 : remove broken link and replace it with another resource.
2011-10-07 16:58:07 +02:00
14c0f03b58
Issue #12943 : python -m tokenize support has been added to tokenize.
2011-10-07 08:53:38 -05:00
b09460f038
Issue #10141 : Don't use hardcoded frame size in example, use struct.calcsize()
2011-10-06 20:27:20 +02:00
47413c1171
Issue #10141 : socket: add SocketCAN (PF_CAN) support. Initial patch by Matthias
...
Fuchs, updated by Tiago Gonçalves.
2011-10-06 19:47:44 +02:00
45d9c91d4b
Issue #3163 : The struct module gets new format characters 'n' and 'N'
...
supporting C integer types `ssize_t` and `size_t`, respectively.
2011-10-06 15:27:40 +02:00
0f4ee93b06
Branch merge
2011-10-06 13:22:21 +02:00
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
1079bdfde3
Merge 3.2
2011-10-05 01:52:45 +02: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
525b1e9dd4
Fix minor wording issue.
...
sys.maxunicode is not called and thus does not return anything; it *is*
something. (I checked the doc quickly to see if it tells that
expression return things but found nothing.)
I also removed markup that would just generate a useless link to the
enclosing section.
2011-10-05 01:06:31 +02:00
91a076a72f
merge from 3.2. Issue #13073 - Address the review comments made by Ezio.
2011-10-05 23:27:37 +08:00
5d0de3fbaa
Document message_body arg in HTTPConnection.endheaders
2011-10-03 07:27:06 +08:00
0069be19e5
merge from 3.2 - Document message_body arg in HTTPConnection.endheaders
2011-10-03 07:28:00 +08:00
6fe679f011
#13076 : merge with 3.2.
2011-10-02 12:47:10 +03:00
35ec7f771b
#13076 : fix links to datetime.time and datetime.datetime.
2011-10-02 12:44:50 +03:00
48a2f8fd97
#13054 : sys.maxunicode is now always 0x10FFFF.
2011-09-29 00:18:19 +03:00
f0c51fabe8
Fix markup.
2011-09-27 07:30:00 +02:00
85579b8f0e
merge 3.2. Fix closes issue13005 - Remove the mention of 'repeat' method in the operator module documentation.
2011-09-22 02:10:09 +08:00
17dac4c0e2
Fix closes issue13005 - Remove the mention of 'repeat' method in the operator module documentation.
2011-09-22 02:09:17 +08:00
9c0cccf363
Branch merge
2011-09-21 16:36:08 +02:00
dd2d55c8a1
Remove two unneeded attributes in packaging
2011-09-21 16:28:03 +02:00
9415afcce1
meth.log2 doc: add a link to int.bit_length()
2011-09-21 03:35:18 +02:00
1c9f0c93ad
Issue #1172711 : Add 'long long' support to the array module.
...
Initial patch by Oren Tirosh and Hirokazu Yamamoto.
2011-09-20 19:55:51 -05:00
2496f331a7
Close issue 12958 by flagging expected failures in test_socket on Mac OS X
2011-09-19 20:26:31 +10:00
ddd2d70cc6
Merge example fix from 3.2.
2011-09-18 07:40:20 +02:00
1d678f8413
Fix bug in heapq priority queue example.
2011-09-18 07:40:05 +02:00
902e895578
merge doc fixes from 3.2
2011-09-17 20:40:35 +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
1c82a14e86
Oops, zlib.ZLIB_VERSION isn't new in 3.3 - just newly-documented...
2011-09-12 00:09:27 +02:00
7cd4f203c0
Terminology fix: .gz and .bz2 are not archive formats.
2011-09-12 00:06:49 +02:00
64d25ddb9c
Issue #12306 : Add ZLIB_RUNTIME_VERSION to the zlib module.
...
While we're at it, also document ZLIB_VERSION.
Patch by Torsten Landschoff.
2011-09-12 00:04:13 +02:00
d964ee9cd5
#12940 : merge with 3.2.
2011-09-10 10:08:13 +03:00
4165bfb6e9
#12940 : fix cmd example. Patch by Tim Chase.
2011-09-10 10:06:01 +03:00
71e44cb97f
Issue #12567 : Add curses.unget_wch() function
...
Push a character so the next get_wch() will return it.
2011-09-06 01:53:03 +02:00
74470b5d3a
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:22:15 +08: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
fbd1e041af
Merge with 3.2.
2011-09-04 08:42:26 +02:00
3484a8771c
Merge with release clone.
2011-09-04 08:35:54 +02:00
a4083d2dd8
merged configparser documentation leftovers cleanup from 3.2
2011-09-02 23:18:39 +02:00
7335e6f3e8
removed misleading editing leftovers
2011-09-02 23:17:39 +02:00
0b6b1c3fb5
#12781 : merge with 3.2
2011-09-02 20:07:34 +02:00
172f374a63
#12781 : Mention SO_REUSEADDR flag near socket examples
2011-09-02 20:06:31 +02:00
677dc7189f
Branch merge
2011-09-02 17:30:55 +02:00
d9e1789364
Branch merge
2011-09-02 17:30:36 +02:00
793c47a88a
Merge doc changes from 3.2 ( #10454 , #12298 )
2011-09-02 00:03:20 +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
c2d9a0226e
Merge doc fix with 3.2.
2011-09-01 08:13:46 +03: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
7194efe8b4
Merge with 3.2.
2011-09-01 07:02:31 +02:00
a9353db2cd
Remove duplicate text in os documentation.
2011-09-01 06:58:52 +02:00
b8edbdf4b9
Merge doc changes from 3.2.
...
rstlint complains about packaging docs but I’m working on those in
another patch.
2011-09-01 05:57:12 +02:00
ec9a5f6399
Add version number for versionchanged directive (backport from 3.3)
2011-09-01 05:55:26 +02:00
95fc53f2b3
Clean up packaging.util: add __all__, remove some unused functions.
...
This huge module is the heir of six distutils modules, and contains
a number of miscellaneous functions. I have attempted to help readers
of the source code with an annoted __all__. Removed or deprecated
functions have been removed from the documentation; I’m working on
another patch to document the remaining public functions.
For the curious:
The unzip_file and untar_file were used by (or intended to be used by)
“pysetup install path/to/archive.tar.gz”, but the code presently used
shutil.unpack_archive and an helper function, so I just deleted them.
They’re still in the repository if we need them in the future.
The find_packages function is not used anymore but I want to discuss
module and package auto-discovery (in “pysetup create”) again before
removing it.
subst_vars now lives in sysconfig; rfc822_escape is inlined in
packaging.metadata. Other functions are for internal use only, or
deprecated; I have left them out of __all__ and sprinkled TODO notes
for future cleanups.
2011-09-01 05:11:29 +02:00
799bd80d8a
expose linux extended file system attributes ( closes #12720 )
2011-08-31 22:15:17 -04: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
b008d3d00c
Synchronize packaging docs with distutils’ (includes fix for #9302 )
2011-08-26 01:23:20 +02:00
4fd1e6a3ba
Issue #12803 : SSLContext.load_cert_chain() now accepts a password argument
...
to be used if the private key is encrypted. Patch by Adam Simpkins.
2011-08-25 14:39:44 +02:00
d902a14dd0
#12191 : add shutil.chown() to change user and/or group owner of a given path also specifying their names.
2011-08-22 23:28:27 +02:00
96fe56abec
Add support for the send/recvmsg API to the socket module. Patch by David Watson and Heiko Wundram. ( Closes #6560 )
2011-08-22 11:55:57 +10:00
795eaeb41f
Issue #12326 : update sys.platform doc for Linux
2011-08-21 12:08:11 +02:00
94e6238e67
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:50:32 +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
2ec723ad87
#12787 : merge with 3.2
2011-08-20 17:06:38 +02:00
9daf98d32a
#12787 : link original MultiCall proposal to webarchive and in a footnote
2011-08-20 17:05:56 +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
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
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
5f4ea28f49
merge with 3.2
2011-08-19 22:55:24 +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
8e35cf0770
merge with 3.2
2011-08-19 18:40:56 +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
87552785c3
Mark abc.abstractproperty as a property
2011-08-19 03:53:51 +02:00
24d6cc6f4f
Merge 3.2
2011-08-19 03:19:36 +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
b389eec440
Move versionadded directive to the top level, as we do in other files
2011-08-16 19:10:24 +02:00
e5905a9413
Fix typo
2011-08-16 19:09:56 +02:00
ae0cbde231
#12204 : merge with 3.2.
2011-08-15 14:28:46 +03: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
7ec7fc4c3b
#12725 : merge with 3.2.
2011-08-14 08:29:49 +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
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
b90770d31b
merge with 3.2
2011-08-12 19:31:56 +02:00
8a3b657f9e
it's 'rather than'; reported by James Bateman on docs@
2011-08-12 19:31:32 +02:00
14eba5fa41
Brench merge
2011-08-12 17:59:25 +02:00
28d39a0c08
Branch merge
2011-08-12 17:40:25 +02:00
f0dda5f876
Closes #12718 : Merge documentation fix from 3.2.
2011-08-11 13:46:54 +01:00
817495a631
Issue #12718 : Add documentation on using custom importers.
2011-08-11 13:45:48 +01:00
54dbfbd675
Fix directive markup
2011-08-10 21:43:13 +02:00
e9715b9001
Merge 3.2
2011-08-10 21:42:23 +02:00
d9d7bca6da
Use real word in English text (i.e. not code)
2011-08-10 04:19:03 +02:00
fcb393c018
Add support for unary plus and unary minus to collections.Counter()
2011-08-09 13:00:40 -07:00
5c3f648c0c
Branch merge
2011-08-08 16:56:17 +02:00
54a1d05877
Branch merge
2011-08-08 16:56:00 +02:00
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
1a41a4114c
#12709 : merge with 3.2
2011-08-08 16:38:47 +02:00
db79e95195
#12709 : add error_callback argument to map_async documentation
2011-08-08 16:38:13 +02:00
c42a568cd4
#12677 : merge with 3.2
2011-08-07 17:13:13 +02:00
2a389e4601
#12677 : correct turtle orientation in doc
2011-08-07 17:12:19 +02:00
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
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
de8c100ef0
Fix grammar
2011-08-06 09:32:11 +03:00
ebd4805df0
Fix grammar
2011-08-06 09:31:09 +03:00
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
2e0153550c
Fix closes Issue12697 - Update the usage syntax of timeit module in the docs.
2011-08-06 13:37:04 +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
90ceb4772b
Fix closes issue12663 - Correcting the ArgumentParser.error description. Patch by Sandro Tosi.
2011-08-03 07:43:01 +08:00
86a1a8974d
Fix closes issue12663 - Correcting the ArgumentParser.error description. Patch by Sandro Tosi.
2011-08-03 07:42:18 +08:00
94b580d423
expose sched.h functions ( closes #12655 )
2011-08-02 17:30:04 -05:00
e4f9e2ff21
#12665 : merge with 3.2
2011-08-02 18:43:49 +02:00
2a8d195328
#12665 : Dictionary view example has error in set operation
2011-08-02 18:42:04 +02:00
b1290a5295
#12670 : merge with 3.2
2011-08-02 16:44:31 +02:00
3083c88898
#12183 : merge with 3.2.
2011-08-02 17:42:24 +03: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
b0fa4b8433
Merge with 3.2
2011-08-01 22:59:40 +02:00
aa71583f09
Use attribute access instead of index access for namedtuple.
2011-08-01 22:58:53 +02:00
b07df00bce
Closes #12667 : Merged fix from 3.2.
2011-08-01 11:32:49 +01:00
952595696a
Closes #12667 : Added documentation for SMTPHandler secure argument.
2011-08-01 11:31:52 +01:00
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
98f2b9bff0
transition move technically correct to obviously so
2011-07-30 12:26:27 -05:00
2c69e3dd82
we can call singleton types now
2011-07-30 10:03:09 -05:00
7f94febd74
merge 3.2
2011-07-30 10:00:02 -05:00
497cd65cec
add space
2011-07-30 09:59:50 -05:00
Georg Brandl
Éric Araujo
Antoine Pitrou
Meador Inge
Victor Stinner
Charles-François Natali
Senthil Kumaran
Ezio Melotti
Ezio Melotti
Nick Coghlan
Nadeem Vawda
Łukasz Langa
Sandro Tosi
Ross Lagerwall
Benjamin Peterson
Vinay Sajip
Raymond Hettinger
Eli Bendersky