Commit Graph

12267 Commits

Author SHA1 Message Date
Éric Araujo 793c47a88a Merge doc changes from 3.2 (#10454, #12298) 2011-09-02 00:03:20 +02:00
Éric Araujo 18ddf826e7 Add links from library/functions to other docs.
Suggested by Terry J. Reedy in #12298.
2011-09-01 23:10:36 +02:00
Éric Araujo 9edd9f035b Fix a few links in the table of built-in functions (#12298) 2011-09-01 23:08:55 +02:00
Éric Araujo 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
Éric Araujo 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
Ezio Melotti c2d9a0226e Merge doc fix with 3.2. 2011-09-01 08:13:46 +03:00
Ezio Melotti 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
Ross Lagerwall 7194efe8b4 Merge with 3.2. 2011-09-01 07:02:31 +02:00
Éric Araujo d9299e97ab Minor improvement to extensions in setup.cfg: check parent package 2011-09-01 07:01:13 +02:00
Ross Lagerwall a9353db2cd Remove duplicate text in os documentation. 2011-09-01 06:58:52 +02:00
Éric Araujo 336b4e4ff3 Minor improvement to extensions section in setup.cfg.
The right-hand part in [extension: foo] is now used as the name of the
extension module.  (I changed the separator from = to : and allowed
whitespace to make the sections look nicer.)
2011-09-01 06:29:11 +02:00
Éric Araujo 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
Éric Araujo ec9a5f6399 Add version number for versionchanged directive (backport from 3.3) 2011-09-01 05:55:26 +02:00
Éric Araujo 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
Benjamin Peterson 799bd80d8a expose linux extended file system attributes (closes #12720) 2011-08-31 22:15:17 -04:00
Éric Araujo 7af8ebb6ce Adapt/remove mentions of functions gone in 3.x 2011-09-01 03:20:13 +02:00
Éric Araujo 37b5f9eebc Fix some misuses of Sphinx roles and one typo 2011-09-01 03:19:30 +02:00
Éric Araujo 941afedd74 Avoid using the default reST role. Makes Doc/tools/rstlint.py happy. 2011-09-01 02:47:34 +02:00
Éric Araujo 83ab3f319b Remove obsolete mentions of the compress program and .Z archives.
Packaging uses the shutil.make_archive function copied from distutils,
which does not support compress.  There is no test to check that
“bdist --format whatever” works, so this slipped by.
2011-08-30 01:19:02 +02:00
Éric Araujo fb639295ac Print all fields when calling “pysetup metadata” without options.
When called without option (“-f field” or “--all”), “pysetup metadata”
didn’t do anything useful.  Now it prints out all metadata fields.  The
“--all” option is removed.
2011-08-29 22:03:46 +02:00
Éric Araujo 84b8ed8a94 3.3 whatsnew: fix markup, add stub for new crypt features 2011-08-29 21:42:47 +02:00
Éric Araujo be573e7d17 Remove outdated pointer to optparse (fixes #11360).
The doc already points to argparse.
2011-08-26 16:38:40 +02:00
Éric Araujo b008d3d00c Synchronize packaging docs with distutils’ (includes fix for #9302) 2011-08-26 01:23:20 +02:00
Éric Araujo 8d9dcd185c Merge from 3.2 (#9302 fix and other changes) 2011-08-26 01:17:56 +02:00
Éric Araujo 77443824f5 Document the "optional" argument of distutils’ Extension class 2011-08-26 00:45:18 +02:00
Éric Araujo 3f5e958a3f Fix type information in distutils API reference (#9302).
Initial patch by Yue Shuaijie.
2011-08-26 00:44:37 +02:00
Éric Araujo cc42ebe450 Make the list of docs contributors sorted again 2011-08-26 00:10:12 +02:00
Antoine Pitrou 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
Georg Brandl 2bb371b2bf Merge 3.2. 2011-08-25 11:52:39 +02:00
Georg Brandl e1eef41a18 Close #12838: fix range() call. 2011-08-25 11:52:26 +02:00
Sandro Tosi aec2f21f71 #12191: added entry in What's New (+ small editing on shutil section) 2011-08-23 00:58:21 +02:00
Sandro Tosi 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
Ezio Melotti 8c9375bb59 #10542: Add 4 macros to work with surrogates: Py_UNICODE_IS_SURROGATE, Py_UNICODE_IS_HIGH_SURROGATE, Py_UNICODE_IS_LOW_SURROGATE, Py_UNICODE_JOIN_SURROGATES. 2011-08-22 20:03:25 +03:00
Nick Coghlan 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
Victor Stinner 795eaeb41f Issue #12326: update sys.platform doc for Linux 2011-08-21 12:08:11 +02:00
Victor Stinner ff3d9399fc Close #12326: sys.platform is now always 'linux' on Linux
On Linux, sys.platform doesn't contain the major version anymore. It is now
always 'linux', instead of 'linux2' or 'linux3' depending on the Linux version
used to build Python.
2011-08-20 23:39:26 +02:00
Antoine Pitrou 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
Antoine Pitrou 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
Sandro Tosi 2ec723ad87 #12787: merge with 3.2 2011-08-20 17:06:38 +02:00
Sandro Tosi 9daf98d32a #12787: link original MultiCall proposal to webarchive and in a footnote 2011-08-20 17:05:56 +02:00
Georg Brandl 2513123d66 Update suspicious ignore file. 2011-09-03 09:28:05 +02:00
Georg Brandl a47e53e42e Update sys.platform doc for #12326. 2011-09-03 09:26:09 +02:00
Łukasz Langa 987b188615 removed misleading editing leftovers 2011-09-02 23:17:39 +02:00
Sandro Tosi 335f204977 #12781: Mention SO_REUSEADDR flag near socket examples 2011-09-02 20:06:31 +02:00
Éric Araujo 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
Éric Araujo 7bb769c092 Add version number for versionchanged directive (backport from 3.3) 2011-09-01 05:55:26 +02:00
Éric Araujo f3c7822ee5 Adapt/remove mentions of functions gone in 3.x 2011-09-01 03:20:13 +02:00
Éric Araujo 43ba354599 Fix some misuses of Sphinx roles and one typo 2011-09-01 03:19:30 +02:00
É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