mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-19 00:00:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
50165 commits 7 branches 624 tags 3.2 GiB
Commit graph

2437 commits

Author SHA1 Message Date
Éric Araujo
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
Éric Araujo
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
Éric Araujo
99c4c340e6 Add missing documentation for logger argument of shutil.make_archive 2011-08-19 02:51:17 +02:00
Éric Araujo
bd858b75ce Turn last automatic footnote in this file into a manually-numbered one 2011-08-19 02:28:40 +02:00
Éric Araujo
cdb86f17bf Branch merge 2011-08-19 02:26:44 +02:00
Éric Araujo
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
Éric Araujo
d478a46d56 Use standard heading for ast module docs 2011-08-19 02:01:14 +02:00
Éric Araujo
67719bde07 Synchronize argparse docs with 3.x versions 2011-08-19 02:00:07 +02:00
Éric Araujo
d9aeb60465 Remove unneeded reST target 2011-08-19 01:47:48 +02:00
Ezio Melotti
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
Ezio Melotti
ca5e908c6e #12725: fix working. Patch by Ben Hayden. 2011-08-14 08:27:36 +03:00
Éric Araujo
569ff91a5a Avoid title case in flowing text (backport from 3.2) 2011-08-13 02:47:38 +02:00
Sandro Tosi
c67975beea it's 'rather than'; reported by James Bateman on docs@ 2011-08-12 19:31:15 +02:00
Sandro Tosi
71a5ea0a9b English fixup, from Mike MacCana on docs@ 2011-08-12 19:11:24 +02:00
Vinay Sajip
5088b504be Issue #12718: Add documentation on using custom importers. 2011-08-11 13:39:52 +01:00
Senthil Kumaran
ea75f4cf3b Fix closes Issue12722 - link heapq source in the text format in the documentation. 2011-08-10 21:54:56 +08:00
Sandro Tosi
a9c9b2c38c #12709: add error_callback argument to map_async documentation 2011-08-08 16:37:44 +02:00
Sandro Tosi
1381a31e39 #12677: correct turtle orientation in doc 2011-08-07 17:09:15 +02:00
Eli Bendersky
e11af59e2a Fix grammar 2011-08-06 09:29:12 +03:00
Senthil Kumaran
b8b71725c3 Fix closes Issue12697 - Update the usage syntax of timeit module in the docs. 2011-08-06 13:34:30 +08:00
Senthil Kumaran
c1ee4ef9dc Fix closes issue12663 - Correcting the ArgumentParser.error description. Patch by Sandro Tosi. 2011-08-03 07:43:52 +08:00
Sandro Tosi
25fb852e55 #12670: Fix struct code after forward declaration on ctypes doc 2011-08-02 16:16:11 +02:00
Senthil Kumaran
22a7b488e0 Fix closes Issue12183 - Explain the Symlink copy behavior in shutil.copytree. Patch by Petri Lehtinen. 2011-08-02 18:50:44 +08:00
Georg Brandl
93d3a8d67c Use attribute access instead of index access for namedtuple. 2011-08-01 22:58:53 +02:00
Vinay Sajip
5d09ba46c9 Closes #12667: Corrected documentation for SMTPHandler secure argument. 2011-08-01 11:28:02 +01:00
Benjamin Peterson
35fd1b9107 be precise 2011-07-30 22:08:09 -05:00
Benjamin Peterson
110b781129 note Ellipsis syntax 2011-07-30 09:59:12 -05:00
Benjamin Peterson
6726af73de add space 2011-07-30 09:58:59 -05:00
Benjamin Peterson
f444f94ed2 document NotImplemented 2011-07-30 09:57:24 -05:00
Eli Bendersky
dedb502f90 Issue #11699: fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen 2011-07-30 11:12:45 +03:00
Éric Araujo
43162e22c5 Document that atexit execution order is undefined (#9788) 2011-07-29 18:04:24 +02:00
Éric Araujo
f0d44bccb7 Add a link target for argparse.Namespace (#8982) 2011-07-29 17:59:17 +02:00
Éric Araujo
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
Éric Araujo
2e1c294d28 Fix “anyways” (following R. David Murray in 5c7520e02d5a) 2011-07-29 11:57:50 +02:00
Éric Araujo
ad84ea11c2 Add links from builtins module docs to built-in functions and constants docs 2011-07-29 11:53:57 +02:00
Éric Araujo
5dd034b84f Minor doc addition for clarity 2011-05-27 04:42:47 +02:00
Éric Araujo
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
Éric Araujo
beb9170cc4 Merge #12417 followup, also removing an extra docstring 2011-07-28 22:32:04 +02:00
Éric Araujo
345fff3de8 Remove mentions of previous license in profile module (#12417 followup) 2011-07-28 22:27:28 +02:00
Ezio Melotti
8171cf52b6 #12642: fix args names in open() doc. 2011-07-27 08:48:52 +03:00
Ross Lagerwall
528c4adc0b Issue #12102: Document that buffered files must be flushed before being used 
with mmap. Patch by Steffen Daode Nurpmeso.
 2011-07-25 07:23:58 +02:00
Ezio Melotti
b952413499 Fix markup. 2011-07-21 11:38:13 +03:00
Senthil Kumaran
cd57ef1a47 merge from 3.2 - Fix closes issue12524 - update http.client POST example with a working example. - Patch contributed by Bharadwaj 2011-07-20 22:02:27 +08:00
Senthil Kumaran
60bf489e8a merge from 3.2 - Fix closes issue12577 - clarify shutil.move documentation. Patch suggestion by Catalin Iacob 2011-07-19 08:05:44 +08:00
Antoine Pitrou
711cb58db1 Issue #6476: Document that os.spawnle and os.spawnve are not thread-safe under Windows. 2011-07-19 01:26:58 +02:00
Senthil Kumaran
1c0ebc0fa5 fix whitespace in rst. 2011-07-18 07:18:40 +08:00
Senthil Kumaran
a2dd57aaf1 merge from 3.2 - Fix closes Issue12478 - HTTPErrorProcess 's methods are http_response and https_response. 2011-07-18 07:16:02 +08:00
Senthil Kumaran
612b2b338b merge from 3.2 - Fix closes Issue12479 - Add HTTPErrorProcessor class definition - Patch by Sandro Tosi 2011-07-18 06:44:11 +08:00
Senthil Kumaran
4c9721ad40 merge from 3.2 - Issue10403 - datetime module documentation changes based on review. 2011-07-17 19:10:10 +08:00
Senthil Kumaran
a09f13a0bc merge from 3.2. 2011-07-17 17:31:51 +08:00