Éric Araujo
eb35f25412
Fix a typo and a broken link (part of #10536 ).
...
Found by Franz Glasner in #2504 .
2011-10-08 02:15:04 +02:00
Antoine Pitrou
5472c1c004
Issue #12823 : remove broken link and replace it with another resource.
2011-10-07 17:03:01 +02:00
Éric Araujo
e954ecb9ba
Branch merge
2011-10-06 13:19:34 +02:00
Senthil Kumaran
41d663f0a5
Issue13073 - Address review comments and add versionchanged information in the docs.
2011-10-05 23:52:49 +08:00
Éric Araujo
2e4a2b6434
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 '2.7' is a CPython detail and
should not be advertised (see #9442 ), even if some stdlib modules
currently rely on that detail.
2011-10-05 02:34:28 +02:00
Éric Araujo
656b04ecf6
Move doc of sys.dont_write_bytecode to make all attributes sorted again
2011-10-05 02:25:58 +02:00
Senthil Kumaran
83cc512a01
update 2.7 - Document message_body arg in HTTPConnection.endheaders
2011-10-03 07:37:58 +08:00
Ezio Melotti
f17e405eb7
#13076 : fix links to datetime.time.
2011-10-02 12:22:13 +03:00
Senthil Kumaran
169fa9345d
Doc fix. Mathematically correct sentence.
2011-09-29 07:52:46 +08:00
Victor Stinner
63c22fac72
Issue #7732 : Fix a crash on importing a module if a directory has the same name
...
than a Python module (e.g. "__init__.py"): don't close the file twice.
PyFile_FromFile() does also close the file if PyString_FromString() failed. It
did already close the file on fill_file_fields() error (e.g. if the file is a
directory).
2011-09-23 19:37:03 +02:00
Georg Brandl
607cc361bb
Fix bug in heapq priority queue example.
2011-09-18 07:40:05 +02:00
Georg Brandl
21c69b1043
Add info from the docstring for random.gammavariate() to the docs.
2011-09-17 20:36:28 +02:00
Éric Araujo
79c9d4faa7
Port a few markup edits from 3.x
2011-09-09 19:20:27 +02:00
Vinay Sajip
fa4736ef2f
Closes #12906 : Fixed bug in YAML configuration.
2011-09-06 14:06:24 +01:00
Victor Stinner
d99ff29cf9
Update sys.platform doc for #12326 .
...
Backport from Python 3.2 (e11b4c945f7e).
2011-09-05 22:33:55 +02:00
Senthil Kumaran
9541f8eb2b
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:23:10 +08:00
Sandro Tosi
cbce2c01a0
Give credit to Adam
2011-09-02 21:23:55 +02:00
Sandro Tosi
a95d19efa6
#12781 : Mention SO_REUSEADDR flag near socket examples
2011-09-02 20:04:20 +02:00
Éric Araujo
b71c15d407
Branch merge
2011-09-02 17:33:10 +02:00
Éric Araujo
cd90f79125
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 19:57:01 +02:00
Éric Araujo
2c378ae364
Document that True/False/None don’t use :keyword: in doc
2011-09-01 19:56:04 +02:00
Éric Araujo
7ce05e07c0
Fix some markup and one typo
2011-09-01 19:54:05 +02:00
Éric Araujo
a7cbe28bcc
Avoid using the default reST role. Makes Doc/tools/rstlint.py happy.
2011-09-01 19:49:31 +02:00
Ezio Melotti
4f14a1ff52
From RFC 3629 5- and 6-bytes UTF-8 sequences are invalid, so remove them from the doc.
2011-09-01 08:19:01 +03:00
Sandro Tosi
9bfc16a99e
added versionadd information for pkgutil.get_data(); thanks to Kyle Monson from docs@
2011-08-30 19:40:28 +02:00
Éric Araujo
ecbb7a9423
Add suspicious entries for the Python Porting HOWTO recently added
2011-08-30 01:39:25 +02:00
Éric Araujo
0f697b300c
Remove outdated pointer to optparse ( fixes #11360 ).
...
The doc already points to argparse.
2011-08-26 16:38:40 +02:00
Éric Araujo
1bd3b9cea0
Branch merge
2011-08-26 16:32:36 +02:00
Éric Araujo
cf13c866b1
Document the "optional" argument of distutils’ Extension class
2011-08-26 00:45:18 +02:00
Éric Araujo
5c2f1f6bfd
Fix type information in distutils API reference ( #9302 ).
...
Initial patch by Yue Shuaijie.
2011-08-26 02:08:20 +02:00
Georg Brandl
eacada8656
Close #12838 : fix range() call.
2011-08-25 11:52:26 +02:00
Antoine Pitrou
b384356b9b
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:51:31 +02:00
Sandro Tosi
9b68092d1d
#12787 : link original MultiCall proposal to webarchive and in a footnote
2011-08-20 17:05:15 +02:00
Sandro Tosi
a7eb3c802e
fix description of \r; thanks to Thomas Waldmann from docs@
2011-08-19 22:54:33 +02:00
Sandro Tosi
da5a9622f1
merge heads
2011-08-19 18:43:43 +02:00
Sandro Tosi
657a7fcb95
mention RFC1123 as origin of 4-year digit; thanks to John Haxby from docs@
2011-08-19 18:39:35 +02:00
Éric Araujo
410024a8fc
Branch merge
2011-08-19 14:24:38 +02:00
Éric Araujo
0dcf59a7bd
Fix typo in command name
2011-08-19 09:30:26 +02:00
Éric Araujo
a2596a4d67
Remove obsolete term + indicate how to find the program ( #1626300 ).
...
Suggested by Terry J. Reedy.
2011-08-19 09:29:56 +02:00
Éric Araujo
e0054c51c7
Link isinstance/issubclass to the ABC glossary entry ( #12256 )
2011-08-19 09:15:47 +02:00
Éric Araujo
f06568cbd8
Fix a typo and remove some unneeded markup
2011-08-19 09:00:56 +02:00
É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
Eli Bendersky
7ceef09b74
Issue #12672 : remove confusing part of sentence in documentation
2011-08-19 06:33:39 +03: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
Éric Araujo
a8f66dd52c
Synchronize glossary with py3k.
...
This update includes new entries that apply to 2.7 too, mention of class
decorators, mention of nonlocal, notes about bytecode, markup fixes and
some rewrappings. Future backports of changes should be slightly
easier.
2011-08-19 01:27:00 +02:00
Éric Araujo
52a5a03498
Add Python porting howto from 3.x.
...
No change was necessary to make the file build, contrary to cporting.rst
that uses markup like :c:func: that needs to be changed to :cfunc: in
2.7. Future backports should be straightforward.
2011-08-19 01:22:42 +02:00
Éric Araujo
f595a76d3d
Backport source role for linking to files in the cpython repo.
...
Georg added this role in our 3.2 doc tools and gave the greenlight for a
backport on python-dev.
This code is a simplified version of the 3.2 code; the version of Sphinx
used with Python 2.7 doesn’t have the function used to parse markup like
:role:`text to be displayed <text to be processed>` (I was persuaded it
was a standard reST construct, but it is actually a Sphinx innovation
that has to be supported explicitly in role code —I’ll be damned). It
is thus not possible to write for example :source:`the NEWS file
<Misc/NEWS>`, but :source:`Misc/NEWS` will work.
2011-08-19 00:12:33 +02:00
Sandro Tosi
02ebf4f78b
grammatical fixes; from Darren Yin on docs@
2011-08-18 15:36:15 +02:00
Sandro Tosi
4047d68a05
#12761 : fix wording of zlib license section
2011-08-16 20:02:15 +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
92be113ba9
let PySequence_Check me a link; thanks to tomo cocoa from docs@
2011-08-13 00:39:29 +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
Georg Brandl
d7fbc8bf12
Repair markup.
2011-08-09 19:47:04 +02:00
Georg Brandl
a350f0f9fd
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
Sandro Tosi
a9c9b2c38c
#12709 : add error_callback argument to map_async documentation
2011-08-08 16:37:44 +02:00
Sandro Tosi
9943c0d5d7
#10741 : add documentation for PyGILState_GetThisThreadState()
2011-08-08 00:15:57 +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
ceed525de1
s/a/an - grammar?
2011-08-06 12:56:08 +08:00
Senthil Kumaran
54f84d7b45
Fix closes issue11047 - Correct the 2.7 whatsnew description for issue 7902.
2011-08-06 12:52:56 +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
Éric Araujo
0db7f72cc7
Branch merge
2011-08-01 14:48:19 +02:00
Vinay Sajip
5d09ba46c9
Closes #12667 : Corrected documentation for SMTPHandler secure argument.
2011-08-01 11:28:02 +01:00
Ezio Melotti
c1fc2e177d
Fix typo reported by Sandro Tosi.
2011-07-31 22:48:45 +03:00
Benjamin Peterson
e62bada41e
merge heads
2011-07-30 22:08:18 -05:00
Benjamin Peterson
35fd1b9107
be precise
2011-07-30 22:08:09 -05:00
Éric Araujo
560bf855d3
Fix regression with distutils MANIFEST handing ( #11104 , #8688 ).
...
The changed behavior of sdist in 2.7 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 (d29399100973 by Tarek and
f7639dcdffc3 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 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. I also removed a stanza in the docs that
was forgotten in Tarek’s first changeset.
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 02:04:00 +02:00
Ezio Melotti
4cfdb077fd
#12531 : Fix spaces.
2011-07-30 21:31:22 +03: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
271208e225
Backout duplicate changeset ed34ca4e639c
2011-07-29 16:28:22 +02:00
Éric Araujo
345fff3de8
Remove mentions of previous license in profile module ( #12417 followup)
2011-07-28 22:27:28 +02:00
Éric Araujo
b274586dd7
Add missing reST target to one heading in the tutorial
2011-06-11 10:34:19 +02:00
Éric Araujo
fea8ac4772
Branch merge
2011-07-29 14:23:13 +02:00
Eli Bendersky
2cdf383cee
Issue #12531 : add index entries to documentation of * and ** in function calls
2011-07-29 14:45:08 +03:00
Éric Araujo
bd21b01079
Turn raw URI into real link
2011-07-28 22:50:18 +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
Ezio Melotti
8171cf52b6
#12642 : fix args names in open() doc.
2011-07-27 08:48:52 +03:00
Éric Araujo
299172bdba
Make indentation comply with our style guide and the rest of the file
2011-07-26 16:54:24 +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
8d2a6fd9a9
Fix typo in 97a75fccd7c8
2011-07-29 11:43:47 +02: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
Georg Brandl
f364ce242d
Fix function name: open -> urlopen.
2011-07-23 08:06:33 +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
Raymond Hettinger
aff394b64f
A number of small fixups for the sorting howto guide.
2011-07-19 01:35:35 -07: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
R David Murray
c8ebbbc09b
Better English.
2011-07-18 12:39:54 -04:00
Georg Brandl
3a04b4b180
Add missing "a".
2011-07-18 10:39:55 +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
Eli Bendersky
877f2e4530
Issue #12574 : correct capitalization of the Queue module. Patch by Rafe Kettler
2011-07-17 05:54:06 +03:00
Raymond Hettinger
cec795d639
It is really a suffix :-)
2011-07-14 14:41:43 +08:00
Ned Deily
0ab67ee79e
Issue #12549 : Correct test_platform to not fail when OS X returns 'x86_64'
...
as the processor type on some Mac systems. Also fix NameError in fallback
_mac_ver_gestalt function. And remove out-of-date URL in docs.
2011-07-13 15:05:31 -07:00
Georg Brandl
fbe84d92ab
Clarify that PyErr_NewException creates an exception *class*, not instance.
2011-07-13 15:59:24 +02:00
Antoine Pitrou
0504532c39
Mention logging.captureWarnings in the warnings module doc.
2011-07-09 21:29:36 +02:00
Antoine Pitrou
73705902c4
Move sys.subversion at the right place in alphabetical order,
...
and add a note concerning its status.
2011-07-09 16:06:19 +02:00
Antoine Pitrou
ea901ad2c6
Issue #12326 : document the recommended idiom for checking sys.platform on Unix systems.
...
Also, point to the various alternatives.
2011-07-09 15:48:29 +02:00
Victor Stinner
8703be94b1
Issue #12423 : Fix os.abort() documentation
...
The Python signal handler for SIGABRT is not called on os.abort() (only if the
signal is raised manually or sent by another process). Patch by Kamil Kisiel.
2011-07-08 02:14:55 +02:00
Senthil Kumaran
6f18b98782
Fix closes issue10403 - Let's not use members anymore.
2011-07-04 12:50:02 -07:00
Senthil Kumaran
e04d256c2d
reST indentation fix in sqlite3 docs. rst uses 3 space indentation.
2011-07-03 10:12:59 -07:00
Ned Deily
43e1054e38
Issue #8746 : Correct faulty configure checks so that os.chflags() and
...
os.lchflags() are once again built on systems that support these
functions (*BSD and OS X). Also add new stat file flags for OS X
(UF_HIDDEN and UF_COMPRESSED). Also add additional tests for
os.chflags() and os.lchflags(). (Tests by Garrett Cooper)
2011-06-27 23:41:53 -07:00
Ezio Melotti
4601530137
#11363 : add missing functions from curses doc. Patch by Sandro Tosi.
2011-06-26 13:34:56 +03:00
Ezio Melotti
14989cf4d1
#11363 : clean up curses doc.
2011-06-26 13:33:46 +03:00
Ezio Melotti
99c9c8534f
#11669 : rephrase footnote in the Compound Statements page.
2011-06-26 11:25:28 +03:00
Senthil Kumaran
7bf5ba0f79
Fix Issue10020 - Doc update to sqlite3 module in 2.7 branch.
2011-06-25 20:48:21 -07:00
Ezio Melotti
196273e1d0
Use correct markup in zipimport.rst. Patch by Sara Magliacane.
2011-06-25 19:40:06 +03:00
Raymond Hettinger
fd1cb59618
Issue 12086: add example showing how to use name mangling.
2011-06-25 16:28:07 +02:00
Raymond Hettinger
320b91495a
Issue 11889: Clarify docs for enumerate.
2011-06-25 14:57:06 +02:00
Mark Dickinson
653a53fb14
Issue #12228 : Fix exchanged flag descriptions in stat.rst. Thanks Sandro Tosi.
2011-06-25 12:01:06 +02:00
R David Murray
17e2b40aae
#9921 : clarify os.path.join joining algorithm
...
The new wording is based on the comments in the code, which
match the actual behavior.
2011-06-23 21:19:25 -04:00
R David Murray
1d3365106d
#12389 : fix missing space at sentence end.
2011-06-22 20:00:27 -04:00
Senthil Kumaran
832288ca18
merge 3.2 - Fix closes Issue12359 - Removing a confusing sentence from the previous change.
2011-06-20 07:34:48 -07:00
Senthil Kumaran
98fec3aa5e
Fix issue12359. Minor doc update on import module description.
2011-06-19 17:45:36 -07:00
R David Murray
491eb6a17e
#6771 : fix docs: curses.wrapper is exposed as a function, not a module
...
Patch by July Tikhonov.
2011-06-18 19:31:22 -04:00
Benjamin Peterson
898d43c7af
update link to pycrypto ( closes #12351 )
2011-06-16 18:49:46 -05:00
Vinay Sajip
ad52cb2613
Closes #12206 : documentation update for LogRecord constructor and Formatter.formatTime.
2011-06-13 14:59:36 +01:00
Eli Bendersky
761473f28a
Issue #12223 : Typo fix in datamodel docs
2011-06-10 10:36:34 +03:00
Éric Araujo
5cf8660f0b
Fix a few misuses of :option: I missed in r86521.
...
Extract of the commit message:
Fix usage of :option: in the docs (#9312 ).
:option: is used to create a link to an option of python, not to mark
up any instance of any arbitrary command-line option. These were
changed to ````.
2011-06-09 14:26:10 +02:00
Éric Araujo
a65a880cd2
Add examples that work on Windows to distutils docs ( #1626300 )
2011-06-08 01:11:36 +02:00
Éric Araujo
3322a25532
Remove outdated bit of advice (c882b5ff92d9 follow-up)
2011-06-04 18:35:04 +02:00
Éric Araujo
d66d95cdd0
Document working dir for “make html” ( #12249 ). Patch by Tshepang Lekhonkhobe.
2011-06-03 19:25:58 +02:00
Raymond Hettinger
45b082935d
Fix named tuples to work with vars().
2011-06-02 20:40:35 -07:00
Raymond Hettinger
88fc66179b
Cleanup example
2011-06-01 16:01:21 -07:00
Raymond Hettinger
690d4ae8bf
Multiple clean-ups to the docs for builtin functions.
...
* Use concrete example for dir() and eliminate the distracting doctest directives.
* Add a pure python equivalent for enumerate()
* Modify the enumerate() example to demonstrate the start argument
* Remove incorrect reference the *iterable* in the enumerate() docs.
* Downgrade the comments on input() from a warning to a note.
* Fix the iter() example to use the empty string as the terminating
condition for file.readline(). Also, the old example was broken
because readline() results include a newline, so 'STOP\n' would have
been the correct terminating condition. Even with that fix, the
STOP example was fragile and would have lead to infinite loops with
malformed inputs.
* Do not refer to classmethod as being "more advanced" than staticmethod.
2011-06-01 15:50:34 -07:00
Raymond Hettinger
783a30f38e
Link to suggestions for how to use super().
2011-06-01 14:57:13 -07:00
Éric Araujo
346d8609a1
Fix markup: arguments in a class directive are __init__ arguments, not base classes
2011-05-31 21:50:22 +02:00
Éric Araujo
28ef3c4726
Re-add missing doc stub for the distutils check command
2011-05-29 00:31:30 +02:00
Éric Araujo
bee18a31ad
Backport doc improvements for distutils.cmd.Command ( #9223 ).
...
Original commit by Georg Brandl.
2011-05-29 00:11:59 +02:00
Éric Araujo
5dd034b84f
Minor doc addition for clarity
2011-05-27 04:42:47 +02:00
Éric Araujo
ec464cf9bb
Add missing reST target to one heading in the tutorial
2011-07-29 11:35:27 +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
18176f06b5
Fix two typos
2011-05-25 18:06:16 +02:00
Barry Warsaw
cf0d8ab818
Replay changeset 70238:03e488b5c009 from fubar branch. Original commit
...
message:
Reconcile with the 2.6svn branch. The 2.6.7 release will be made from
Subversion, but there were differences, so this brings them in sync. These
changes should *not* propagate to any newer versions.
2011-05-23 15:22:56 -04:00
Eli Bendersky
29f6efa844
Issue 12003: fixing error in xrange alternative sample
2011-05-23 06:10:26 +03:00
Eli Bendersky
e91b305d28
Issue 12126: removing incorrect claim about return value of select
2011-05-22 06:49:01 +03:00
Raymond Hettinger
691a659ddb
Simplify example
2011-05-21 09:39:57 -07:00
Benjamin Peterson
ce77defd84
this should actually be an IOError
2011-05-20 11:49:06 -05:00
Benjamin Peterson
30e10d8114
add example for not using access
2011-05-20 11:41:13 -05:00
Ezio Melotti
52f63eabeb
#12072 : add missing parenthesis in the doc. Patch by Sandro Tosi.
2011-05-20 15:04:38 +03:00
Ezio Melotti
bfbd1a2fd4
#12092 : backport rephrasing of a paragraph in the tutorial.
2011-05-17 05:39:22 +03:00
Ezio Melotti
b429c57481
#12093 : fix typo in struct doc. Patch by Sandro Tosi.
2011-05-17 05:17:35 +03:00
Georg Brandl
11041f0af9
Port #6498 fix: fix several misspellings of "SystemExit" as "SystemError".
2011-05-15 08:50:32 +02:00
Ezio Melotti
9b323a521c
#11979 : improve wording and markup in sockets howto. Patch by Xavier Morel.
2011-05-14 09:17:52 +03:00
Georg Brandl
073070629b
#12061 : remove duplicate glossary entry.
2011-05-12 07:47:06 +02:00
Antoine Pitrou
47d1d0dc30
Issue #8498 : In socket.accept(), allow to specify 0 as a backlog value in
...
order to accept exactly one connection. Patch by Daniel Evers.
2011-05-10 19:16:03 +02:00
Raymond Hettinger
351761236a
Issue 12047: Expand the style guide.
2011-05-10 00:39:02 -07:00
Victor Stinner
b1241f9619
(Merge 3.1) Issue #12012 : ssl.PROTOCOL_SSLv2 becomes optional
...
OpenSSL is now compiled with OPENSSL_NO_SSL2 defined (without the SSLv2
protocol) on Debian: fix the ssl module on Debian Testing and Debian Sid.
Optimize also ssl.get_protocol_name(): speed does matter!
2011-05-10 01:52:03 +02:00
Ezio Melotti
87b86c84ef
Add a note to the str.find doc to suggest the use of the "in" operator.
2011-05-09 03:54:30 +03:00
Ezio Melotti
fe12aa67fc
#11997 : fix typo in init.rst.
2011-05-05 14:19:48 +03:00
Brian Curtin
1602ec109b
Fix #11834 . Correct site-packages paths.
...
Patch by Bryce Verdier.
2011-05-03 22:01:53 -05:00
Ezio Melotti
001cc954bb
#11985 : document the return value of platform.python_implementation for PyPy.
2011-05-03 20:41:48 +03:00
Victor Stinner
112d48ac17
(Merge 3.1) Issue #11277 : mmap.mmap() calls fcntl(fd, F_FULLFSYNC) on Mac OS X
...
to get around a mmap bug with sparse files. Patch written by Steffen Daode
Nurpmeso.
2011-05-03 14:36:36 +02:00
Éric Araujo
cfa8483051
Branch merge
2011-05-02 13:36:18 +02:00
Éric Araujo
941592aa19
Fix grammar to include both integer types in 2.x
2011-05-02 13:09:36 +02:00
Raymond Hettinger
ec0ecb1afc
Fix spelling.
2011-05-01 18:14:49 -07:00
Benjamin Peterson
17ebbdb73e
note abcs of int and float ( closes #11977 )
2011-05-01 17:38:17 -05:00
Georg Brandl
12b8fcfc45
Split combined code/doctest code blocks in two blocks, to enable proper highlighting.
2011-05-01 22:36:31 +02:00
Éric Araujo
2a53d33dc6
Fix wording
2011-05-01 02:15:03 +02:00
R David Murray
dd6ab85384
#11883 : fix email examples by adding 'localhost' to SMTP constructor calls
2011-04-30 17:26:02 -04:00
R David Murray
dcaacbf1ef
#11901 : post-commit review fixes per Georg Brandl
2011-04-30 16:34:35 -04:00
Benjamin Peterson
2a7a3ee39a
fix function name in example ( closes #11966 )
2011-04-30 13:14:56 -05:00
Eli Bendersky
b22f39cb94
fix formatting, :c:func: --> :cfunc:
2011-04-30 09:02:12 +03:00
Eli Bendersky
11d1171ecf
Issue #10912 : add clarification for PyObject_RichCompareBool comparing identical objects
2011-04-30 08:51:55 +03:00
Brian Curtin
bb23bd69b9
Fix #11961 . Document STARTUPINFO and creation flag options.
2011-04-29 22:23:46 -05:00
Ezio Melotti
6940e61225
#11952 : Fix typo in multiprocessing doc.
2011-04-29 07:10:24 +03:00
Łukasz Langa
9d68ad862a
Merged solution for #11786 from 2.6
2011-04-28 17:40:19 +02:00
Łukasz Langa
22108f1bb0
Closes #11786 : ConfigParser.[Raw]ConfigParser optionxform().
2011-04-28 17:27:59 +02:00
Raymond Hettinger
bd0933a687
Issue #11940 : Update external link.
2011-04-27 16:34:07 -07:00
Ezio Melotti
cd12746ce9
#11942 : Fix return type of Py_AddPendingCall. Patch by Sandro Tosi.
2011-04-28 00:48:46 +03:00
R David Murray
a0895db2e1
#11901 : add description of how bitfields are laid out to hexversion docs
...
Patch by Sijin Joseph.
2011-04-25 16:10:18 -04:00
Ezio Melotti
c69313a7ab
Fix some more markup glitches in argparse doc.
2011-04-22 01:29:13 +03:00
Ezio Melotti
569083adbf
The \ is not supported in Sphinx 0.6.
2011-04-21 23:30:27 +03:00
Ezio Melotti
d281f1439d
#11905 : fix missing full stop in argparse doc. Noticed by Vladimir Rutsky.
2011-04-21 23:09:27 +03:00
Ezio Melotti
310619c80f
#11904 : fix indentation in argparse doc. Noticed by Vladimir Rutsky.
2011-04-21 23:06:48 +03:00
Ezio Melotti
0a43ecc9df
#11902 : Fix typo in argparse doc. Noticed by Vladimir Rutsky.
2011-04-21 22:56:51 +03:00
Ezio Melotti
01b600c2a3
Add the :mod: role where it was missing.
2011-04-21 16:12:17 +03:00
Ezio Melotti
2eab88e834
#11885 : capitalize Python.
2011-04-21 15:26:46 +03:00
Ezio Melotti
ffdf94ae79
Fix wrong function name. Noticed by Clive Darke.
2011-04-20 21:29:31 +03:00
Ezio Melotti
b4923786fa
Fix wrong number of functions noticed by Sandro Tosi.
2011-04-19 23:12:37 +03:00
Vinay Sajip
0513275b58
Updated documentation on fileConfig().
2011-04-19 13:47:23 +01:00
Victor Stinner
059061a237
Issue #11768 : signal.set_wakeup_fd() and PySignal_SetWakeupFd() added in 2.6
...
Fix the documentation.
2011-04-18 16:34:31 +02:00
Ezio Melotti
8e4eeef4ee
#11865 : fix typo in init.rst.
2011-04-18 10:11:21 +03:00
Éric Araujo
46c09da3ca
Advertise nesting directives for class/method and class/data combos.
...
Also fix a typo and a misleading example (method used to describe function).
2011-04-16 23:47:53 +02:00
Ezio Melotti
12125823fa
Fix a few hyphens in argparse.rst.
2011-04-16 23:04:51 +03:00
Eli Bendersky
ad72bb1aa8
Issue #11855 : Apply missing formatting for urlretrieve
2011-04-16 15:28:42 +03:00
Raymond Hettinger
df453fbb5f
Add another example to the collections module docs.
2011-04-15 17:55:36 -07:00
Ezio Melotti
65c620d0c7
#11843 : remove duplicate line from table in distutil doc.
2011-04-15 18:05:09 +03:00
Ezio Melotti
6033d26118
#4783 : document that is not possible to use json.dump twice on the same stream.
2011-04-15 07:37:00 +03:00
Eli Bendersky
929e276176
Issue #11827 : remove mention of list2cmdline in the doc of subprocess
2011-04-15 07:35:06 +03:00
Ezio Melotti
020f6508c1
#11840 : Improve c-api/unicode documentation. Patch by Sandro Tosi.
2011-04-14 07:39:06 +03:00
Ezio Melotti
7f9d2ead34
#9101 : backport json reference in configparser doc.
2011-04-14 06:53:44 +03:00
R David Murray
a2472d28fd
Transplant: Fix wording and clarify that the IDNA codec operates on full domain names.
...
Before reading the code to check, I wasn't sure if it operated on
full domain names or just individual labels.
2011-04-13 14:20:30 -04:00
R David Murray
ea8b6ef15f
#10019 : Fix regression relative to 2.6: add newlines if indent=0
...
Patch by Amaury Forgeot d'Arc, updated by Sando Tosi.
2011-04-12 21:00:26 -04:00
Vinay Sajip
5dbca9cc3f
Issue #11794 : Reorganised logging documentation.
2011-04-08 11:40:38 +01:00
Vinay Sajip
3c599bdbd1
Issue #11639 : Configuration function documentation referred to logging.XXX rather than logging.config.XXX.
2011-03-29 01:21:48 +01:00
Vinay Sajip
f851fe9fc5
Issue #11639 : Configuration function documentation referred to logging.XXX rather than logging.config.XXX.
2011-03-29 01:15:37 +01:00
Vinay Sajip
af1fee06c9
Issue #11639 : Configuration function documentation referred to logging.XXX rather than logging.config.XXX.
2011-03-29 01:07:50 +01:00
Ezio Melotti
d113512ed5
#10617 : add class directives to collections ABCs.
2011-03-28 13:46:28 +03:00
Steven Bethard
5e0062d25a
Issue #9343 : Document that argparse parent parsers must be configured before their children. (Merge from 3.2.)
2011-03-26 21:50:38 +01:00
Steven Bethard
3f69a059b9
Issue #8982 : Improve the documentation for the argparse Namespace object. (Merge from 3.2.)
2011-03-26 19:59:02 +01:00
Éric Araujo
254d4b851d
Tweaks to sys.flags description table.
...
The options listed in the table are now links to their documentation,
and the table uses compact markup to make it easier to read and edit.
First proposed in #10998 .
2011-03-26 02:09:14 +01:00
Éric Araujo
10ab95a271
Remove untrue statement from tutorial
2011-03-26 01:26:08 +01:00
Éric Araujo
8bea9a5b13
Use universal construct os.path.expanduser('~') instead of os.environ['HOME']
2011-03-26 01:24:47 +01:00
Raymond Hettinger
1fd26525a4
Issue #10771 : Clarify that descriptors get used in an *owner* class or one of its parents.
2011-03-22 17:51:57 -07:00
Raymond Hettinger
405a4717e1
Issue 10787: Document the probability density function for random.gammavariate.
2011-03-22 15:52:46 -07:00
Raymond Hettinger
b76f6200d2
Issue 10988: fix description of super's descriptor call.
2011-03-22 15:28:45 -07:00
Éric Araujo
4fbd88a078
Fix typo spotted by Sandro Tosi
2011-03-22 21:45:42 +01:00
Raymond Hettinger
7250730afc
Issue #11625 : Fix Typo
2011-03-22 09:06:38 -07:00
Georg Brandl
b6dc81df2b
Fix duplicate word.
2011-03-21 08:55:16 +01:00
Éric Araujo
c75f26511b
Fix typo in class name
2011-03-20 18:34:24 +01:00
Benjamin Peterson
ec5b5cb489
the name of the option is a bit too low-level
2011-03-20 12:24:20 -05:00
Raymond Hettinger
dbc5e1280f
Minor doc clean-up.
...
* Show list of fields option before showing the single string alternative.
* Remove the PS2 prompts so that the examples become cut-and-pastable.
2011-03-19 15:09:00 -07:00
Ezio Melotti
c2077b0d9b
#11565 : Fix several typos. Patch by Piotr Kasprzyk.
2011-03-16 12:34:31 +02:00
R David Murray
ab40e4cb95
Merge #11216 : document all possible set_charset execution paths.
2011-03-15 18:01:04 -04:00
Ross Lagerwall
a3ed3f03d7
Issue #10885 : Fix multiprocessing docs typo
2011-03-14 10:43:36 +02:00
Ezio Melotti
ad797b699d
#11484 : remove paragraph about with_traceback from 2.7 doc.
2011-03-13 22:55:41 +02:00
Antoine Pitrou
8b78a9d8ca
Remove documentation to non-existent function PyObject_CopyToObject ( fixes #11478 )
2011-03-13 19:35:04 +01:00
Eli Bendersky
ec40bab21e
Issue #11426 : use 'with' statements on open files in CSV examples
2011-03-13 08:45:19 +02:00
Ezio Melotti
dd6833d20a
Fix markup in inputoutput.rst.
2011-03-13 02:13:08 +02:00
Benjamin Peterson
4f1a665fae
clarify condition for readline to return EOF ( closes #11312 )
2011-03-12 17:12:54 -06:00
Vinay Sajip
5ddf51f735
Fixes issue #11476 : StreamHandler parameter name change documented.
2011-03-12 22:43:23 +00:00
Ezio Melotti
c3ab30b363
Fix typo.
2011-03-12 22:21:37 +02:00
Benjamin Peterson
3c5edd00a7
trunc -> math.trunc ( closes #11475 )
2011-03-12 11:58:15 -06:00