f9cc80d601
Improve HTMLParser example in the doc.
2011-10-28 14:14:34 +03:00
24c51809cf
#13278 : fix typo.
2011-10-28 12:22:25 +03:00
e6fda8575e
Added lost documentation cross-reference.
2011-10-27 17:51:13 +01:00
87ba642ce6
Issue #13237 : Make the subprocess convenience helper documentation self-contained aside from the shared parameter description. Downgrade the pipe warnings at that level to notes (since those pipes are hidden, people are unlikely to even try it)
2011-10-27 17:55:13 +10:00
63c54e819e
Issue #13237 : fix typo
2011-10-26 21:34:26 +10:00
65ad31a8f8
Issue #13237 : remove some details that only apply to the 3.x version of this module and cross reference the relocated warning about the dangers of invoking the shell with untrusted input
2011-10-26 21:15:53 +10:00
2ed203af87
Issue #13237 : further updates to subprocess documentation
2011-10-26 21:05:56 +10:00
59b13f4de9
Refactor a bit the codecs doc.
2011-10-25 10:46:22 +03:00
22dabb6ffa
merge heads
2011-10-24 08:51:46 -04:00
414ffa86b5
note callable is back in 3.2
2011-10-24 08:51:15 -04:00
8671157863
Issue #13237 : Rearrange subprocess module documentation to emphasise the convenience functions and commonly needed arguments
2011-10-24 22:19:40 +10:00
df10d7cb97
Issue #13141 : Demonstrate recommended style for SocketServer examples.
2011-10-23 23:07:22 +02:00
c8065e46fe
Whoops, PyException_GetTraceback() is not documented on 2.7
2011-10-23 21:52:10 +03:00
19465ddc1c
Add the green "New reference" note to the doc of PyException_GetTraceback()
2011-10-23 21:34:57 +03:00
b21f51a9d0
Note that the #1548891 fix indirectly fixes shlex ( #6988 , #1170 )
2011-10-23 04:37:51 +02:00
5a77fe92bd
Issue #1548891 : The cStringIO.StringIO() constructor now encodes unicode
...
arguments with the system default encoding just like the write() method
does, instead of converting it to a raw buffer.
2011-10-22 21:26:01 +02:00
5e30fa5f56
#13233 : fix typo.
2011-10-20 19:49:29 +03:00
a1958734cb
#13219 : clarify section about character sets in the re documentation.
2011-10-20 19:31:08 +03:00
ddd40312d5
Fix closes Issue6090 - Raise a ValueError, instead of failing with unrelated
...
exceptions, when a document with timestamp earlier than 1980 is provided to
zipfile. Patch contributed by Petri Lehtinen.
2011-10-20 01:38:35 +08:00
1e87da16ea
Remove duplication.
2011-10-19 10:39:35 +03:00
086f927f25
#12277 : add missing comma.
2011-10-18 13:02:11 +03:00
9bcbc62062
Update dead references from py.org/dev/faq to the devguide ( #13176 )
2011-10-14 18:05:56 +02:00
7c4b0475ec
Fix/improve markup in whatsnew/2.7.
2011-10-10 00:25:47 +03:00
c54d97b961
#13138 : add missing versionadded. Patch by Andreas Stührk.
2011-10-09 23:56:51 +03:00
3e0a3faaa2
Clean-up and improve the priority queue example in the heapq docs.
2011-10-09 17:32:43 +01:00
fc45bbaccc
Issue #13053 : Added section on migrating from CObject to Capsule
...
to howto/cporting.rst.
2011-10-09 13:03:44 +01:00
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
5472c1c004
Issue #12823 : remove broken link and replace it with another resource.
2011-10-07 17:03:01 +02:00
e954ecb9ba
Branch merge
2011-10-06 13:19:34 +02:00
41d663f0a5
Issue13073 - Address review comments and add versionchanged information in the docs.
2011-10-05 23:52:49 +08:00
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
656b04ecf6
Move doc of sys.dont_write_bytecode to make all attributes sorted again
2011-10-05 02:25:58 +02:00
83cc512a01
update 2.7 - Document message_body arg in HTTPConnection.endheaders
2011-10-03 07:37:58 +08:00
f17e405eb7
#13076 : fix links to datetime.time.
2011-10-02 12:22:13 +03:00
169fa9345d
Doc fix. Mathematically correct sentence.
2011-09-29 07:52:46 +08:00
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
607cc361bb
Fix bug in heapq priority queue example.
2011-09-18 07:40:05 +02:00
21c69b1043
Add info from the docstring for random.gammavariate() to the docs.
2011-09-17 20:36:28 +02:00
79c9d4faa7
Port a few markup edits from 3.x
2011-09-09 19:20:27 +02:00
fa4736ef2f
Closes #12906 : Fixed bug in YAML configuration.
2011-09-06 14:06:24 +01:00
d99ff29cf9
Update sys.platform doc for #12326 .
...
Backport from Python 3.2 (e11b4c945f7e).
2011-09-05 22:33:55 +02:00
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
cbce2c01a0
Give credit to Adam
2011-09-02 21:23:55 +02:00
a95d19efa6
#12781 : Mention SO_REUSEADDR flag near socket examples
2011-09-02 20:04:20 +02:00
b71c15d407
Branch merge
2011-09-02 17:33:10 +02:00
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
2c378ae364
Document that True/False/None don’t use :keyword: in doc
2011-09-01 19:56:04 +02:00
7ce05e07c0
Fix some markup and one typo
2011-09-01 19:54:05 +02:00
a7cbe28bcc
Avoid using the default reST role. Makes Doc/tools/rstlint.py happy.
2011-09-01 19:49:31 +02:00
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
9bfc16a99e
added versionadd information for pkgutil.get_data(); thanks to Kyle Monson from docs@
2011-08-30 19:40:28 +02:00
ecbb7a9423
Add suspicious entries for the Python Porting HOWTO recently added
2011-08-30 01:39:25 +02:00
0f697b300c
Remove outdated pointer to optparse ( fixes #11360 ).
...
The doc already points to argparse.
2011-08-26 16:38:40 +02:00
1bd3b9cea0
Branch merge
2011-08-26 16:32:36 +02:00
cf13c866b1
Document the "optional" argument of distutils’ Extension class
2011-08-26 00:45:18 +02:00
5c2f1f6bfd
Fix type information in distutils API reference ( #9302 ).
...
Initial patch by Yue Shuaijie.
2011-08-26 02:08:20 +02:00
eacada8656
Close #12838 : fix range() call.
2011-08-25 11:52:26 +02:00
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
9b68092d1d
#12787 : link original MultiCall proposal to webarchive and in a footnote
2011-08-20 17:05:15 +02:00
a7eb3c802e
fix description of \r; thanks to Thomas Waldmann from docs@
2011-08-19 22:54:33 +02:00
da5a9622f1
merge heads
2011-08-19 18:43:43 +02:00
657a7fcb95
mention RFC1123 as origin of 4-year digit; thanks to John Haxby from docs@
2011-08-19 18:39:35 +02:00
410024a8fc
Branch merge
2011-08-19 14:24:38 +02:00
0dcf59a7bd
Fix typo in command name
2011-08-19 09:30:26 +02:00
a2596a4d67
Remove obsolete term + indicate how to find the program ( #1626300 ).
...
Suggested by Terry J. Reedy.
2011-08-19 09:29:56 +02:00
e0054c51c7
Link isinstance/issubclass to the ABC glossary entry ( #12256 )
2011-08-19 09:15:47 +02:00
f06568cbd8
Fix a typo and remove some unneeded markup
2011-08-19 09:00:56 +02:00
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
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
7ceef09b74
Issue #12672 : remove confusing part of sentence in documentation
2011-08-19 06:33:39 +03:00
99c4c340e6
Add missing documentation for logger argument of shutil.make_archive
2011-08-19 02:51:17 +02:00
bd858b75ce
Turn last automatic footnote in this file into a manually-numbered one
2011-08-19 02:28:40 +02:00
cdb86f17bf
Branch merge
2011-08-19 02:26:44 +02:00
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
d478a46d56
Use standard heading for ast module docs
2011-08-19 02:01:14 +02:00
67719bde07
Synchronize argparse docs with 3.x versions
2011-08-19 02:00:07 +02:00
d9aeb60465
Remove unneeded reST target
2011-08-19 01:47:48 +02:00
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
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
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
02ebf4f78b
grammatical fixes; from Darren Yin on docs@
2011-08-18 15:36:15 +02:00
4047d68a05
#12761 : fix wording of zlib license section
2011-08-16 20:02:15 +02:00
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
ca5e908c6e
#12725 : fix working. Patch by Ben Hayden.
2011-08-14 08:27:36 +03:00
569ff91a5a
Avoid title case in flowing text (backport from 3.2)
2011-08-13 02:47:38 +02:00
92be113ba9
let PySequence_Check me a link; thanks to tomo cocoa from docs@
2011-08-13 00:39:29 +02:00
c67975beea
it's 'rather than'; reported by James Bateman on docs@
2011-08-12 19:31:15 +02:00
71a5ea0a9b
English fixup, from Mike MacCana on docs@
2011-08-12 19:11:24 +02:00
5088b504be
Issue #12718 : Add documentation on using custom importers.
2011-08-11 13:39:52 +01:00
ea75f4cf3b
Fix closes Issue12722 - link heapq source in the text format in the documentation.
2011-08-10 21:54:56 +08:00
d7fbc8bf12
Repair markup.
2011-08-09 19:47:04 +02:00
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
a9c9b2c38c
#12709 : add error_callback argument to map_async documentation
2011-08-08 16:37:44 +02:00
9943c0d5d7
#10741 : add documentation for PyGILState_GetThisThreadState()
2011-08-08 00:15:57 +02:00
1381a31e39
#12677 : correct turtle orientation in doc
2011-08-07 17:09:15 +02:00
e11af59e2a
Fix grammar
2011-08-06 09:29:12 +03:00
b8b71725c3
Fix closes Issue12697 - Update the usage syntax of timeit module in the docs.
2011-08-06 13:34:30 +08:00
ceed525de1
s/a/an - grammar?
2011-08-06 12:56:08 +08:00
54f84d7b45
Fix closes issue11047 - Correct the 2.7 whatsnew description for issue 7902.
2011-08-06 12:52:56 +08:00
c1ee4ef9dc
Fix closes issue12663 - Correcting the ArgumentParser.error description. Patch by Sandro Tosi.
2011-08-03 07:43:52 +08:00
25fb852e55
#12670 : Fix struct code after forward declaration on ctypes doc
2011-08-02 16:16:11 +02:00
22a7b488e0
Fix closes Issue12183 - Explain the Symlink copy behavior in shutil.copytree. Patch by Petri Lehtinen.
2011-08-02 18:50:44 +08:00
93d3a8d67c
Use attribute access instead of index access for namedtuple.
2011-08-01 22:58:53 +02:00
0db7f72cc7
Branch merge
2011-08-01 14:48:19 +02:00
5d09ba46c9
Closes #12667 : Corrected documentation for SMTPHandler secure argument.
2011-08-01 11:28:02 +01:00
c1fc2e177d
Fix typo reported by Sandro Tosi.
2011-07-31 22:48:45 +03:00
e62bada41e
merge heads
2011-07-30 22:08:18 -05:00
35fd1b9107
be precise
2011-07-30 22:08:09 -05:00
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
4cfdb077fd
#12531 : Fix spaces.
2011-07-30 21:31:22 +03:00
110b781129
note Ellipsis syntax
2011-07-30 09:59:12 -05:00
6726af73de
add space
2011-07-30 09:58:59 -05:00
f444f94ed2
document NotImplemented
2011-07-30 09:57:24 -05:00
dedb502f90
Issue #11699 : fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen
2011-07-30 11:12:45 +03:00
43162e22c5
Document that atexit execution order is undefined ( #9788 )
2011-07-29 18:04:24 +02:00
f0d44bccb7
Add a link target for argparse.Namespace ( #8982 )
2011-07-29 17:59:17 +02:00
271208e225
Backout duplicate changeset ed34ca4e639c
2011-07-29 16:28:22 +02:00
b274586dd7
Add missing reST target to one heading in the tutorial
2011-06-11 10:34:19 +02:00
fea8ac4772
Branch merge
2011-07-29 14:23:13 +02:00
2cdf383cee
Issue #12531 : add index entries to documentation of * and ** in function calls
2011-07-29 14:45:08 +03:00
bd21b01079
Turn raw URI into real link
2011-07-28 22:50:18 +02:00
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
8171cf52b6
#12642 : fix args names in open() doc.
2011-07-27 08:48:52 +03:00
299172bdba
Make indentation comply with our style guide and the rest of the file
2011-07-26 16:54:24 +02:00
2e1c294d28
Fix “anyways” (following R. David Murray in 5c7520e02d5a)
2011-07-29 11:57:50 +02:00
ad84ea11c2
Add links from builtins module docs to built-in functions and constants docs
2011-07-29 11:53:57 +02:00
8d2a6fd9a9
Fix typo in 97a75fccd7c8
2011-07-29 11:43:47 +02:00
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
f364ce242d
Fix function name: open -> urlopen.
2011-07-23 08:06:33 +02:00
b952413499
Fix markup.
2011-07-21 11:38:13 +03:00
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
aff394b64f
A number of small fixups for the sorting howto guide.
2011-07-19 01:35:35 -07:00
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
711cb58db1
Issue #6476 : Document that os.spawnle and os.spawnve are not thread-safe under Windows.
2011-07-19 01:26:58 +02:00
c8ebbbc09b
Better English.
2011-07-18 12:39:54 -04:00
3a04b4b180
Add missing "a".
2011-07-18 10:39:55 +02:00
1c0ebc0fa5
fix whitespace in rst.
2011-07-18 07:18:40 +08:00
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
612b2b338b
merge from 3.2 - Fix closes Issue12479 - Add HTTPErrorProcessor class definition - Patch by Sandro Tosi
2011-07-18 06:44:11 +08:00
4c9721ad40
merge from 3.2 - Issue10403 - datetime module documentation changes based on review.
2011-07-17 19:10:10 +08:00
a09f13a0bc
merge from 3.2.
2011-07-17 17:31:51 +08:00
877f2e4530
Issue #12574 : correct capitalization of the Queue module. Patch by Rafe Kettler
2011-07-17 05:54:06 +03:00
cec795d639
It is really a suffix :-)
2011-07-14 14:41:43 +08:00
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
fbe84d92ab
Clarify that PyErr_NewException creates an exception *class*, not instance.
2011-07-13 15:59:24 +02:00
0504532c39
Mention logging.captureWarnings in the warnings module doc.
2011-07-09 21:29:36 +02:00
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
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
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
6f18b98782
Fix closes issue10403 - Let's not use members anymore.
2011-07-04 12:50:02 -07:00
Ezio Melotti
Vinay Sajip
Nick Coghlan
Benjamin Peterson
Florent Xicluna
Petri Lehtinen
Éric Araujo
Antoine Pitrou
Senthil Kumaran
Raymond Hettinger
Larry Hastings
Victor Stinner
Georg Brandl
Sandro Tosi
Eli Bendersky
Ross Lagerwall
R David Murray
Ned Deily