Commit graph

11624 commits

Author SHA1 Message Date
É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
Éric Araujo
4d71a66a01 Fix typo in command name 2011-08-19 03:44: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
f6b25b9e35 #12761: fix wording of zlib license section 2011-08-16 20:03:11 +02: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
388c945e97 #12725: fix working. Patch by Ben Hayden. 2011-08-14 08:28:57 +03: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
8a3b657f9e it's 'rather than'; reported by James Bateman on docs@ 2011-08-12 19:31:32 +02:00
Éric Araujo
28d39a0c08 Branch merge 2011-08-12 17:40:25 +02:00
Vinay Sajip
817495a631 Issue #12718: Add documentation on using custom importers. 2011-08-11 13:45:48 +01:00
Éric Araujo
d9d7bca6da Use real word in English text (i.e. not code) 2011-08-10 04:19:03 +02:00
Benjamin Peterson
77c4fd01dd note mutating tp_dict is bad (closes #12719) 2011-08-09 16:07:01 -05:00
Éric Araujo
da3f4ae34b Branch merge 2011-08-09 18:01:38 +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
54a1d05877 Branch merge 2011-08-08 16:56:00 +02:00
Sandro Tosi
db79e95195 #12709: add error_callback argument to map_async documentation 2011-08-08 16:38:13 +02:00
Sandro Tosi
61baee0ee7 #10741: add documentation for PyGILState_GetThisThreadState() 2011-08-08 00:16:54 +02:00
Sandro Tosi
2a389e4601 #12677: correct turtle orientation in doc 2011-08-07 17:12:19 +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
ebd4805df0 Fix grammar 2011-08-06 09:31:09 +03: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
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
86a1a8974d Fix closes issue12663 - Correcting the ArgumentParser.error description. Patch by Sandro Tosi. 2011-08-03 07:42:18 +08:00
Sandro Tosi
2a8d195328 #12665: Dictionary view example has error in set operation 2011-08-02 18:42:04 +02: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
aa71583f09 Use attribute access instead of index access for namedtuple. 2011-08-01 22:58:53 +02:00
Éric Araujo
2ffea0e8d7 Branch merge 2011-08-01 14:43:45 +02:00
Vinay Sajip
952595696a Closes #12667: Added documentation for SMTPHandler secure argument. 2011-08-01 11:31:52 +01:00
Ezio Melotti
222e61e444 Fix typo reported by Sandro Tosi. 2011-07-31 22:49:18 +03: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
Ezio Melotti
592563292c #12531: Fix spaces and markup. 2011-07-30 21:25:22 +03: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
e250358062 Issue #11699: fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen 2011-07-30 11:14:32 +03: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
7bd081c117 Issue #12531: add index entries to documentation of * and ** in function calls 2011-07-30 07:05:16 +03:00