b19284f6eb
Issue #12245 : Document sys.float_info.rounds better.
2011-11-19 16:26:08 +00:00
aa512f05a4
#13387 : add note about checking the exact type in assertIsInstance doc.
2011-11-18 18:59:36 +02:00
ba41c6a1c3
#13426 : fix typo in pickle doc.
2011-11-18 13:41:58 +02:00
9efddb654b
fixing typos in optparse doc
2011-11-16 06:01:14 +02:00
ea4dcd33e5
remove duplicated paragraph in the tutorial
2011-11-16 05:54:07 +02:00
eb7113888e
Normalize the keyword arguments documentation notation in re.rst. Closes issue #12875
2011-11-14 01:02:20 +02:00
3a8501e71f
Closes issue 12767: document the argument of threading.Condition.notify
2011-11-12 20:51:54 +02:00
a203cedf44
Issue #12875 : explicitly specify default value of the optional 'flags' argument to re.* functions. Closes #12875
2011-11-11 21:25:56 +02:00
bba1dd5332
Issue #13191 : typo in argparse docs
2011-11-11 16:42:11 +02:00
5df091a91e
Closes issue #13353 : version doumentation about utc parameter corrected.
2011-11-06 22:37:17 +00:00
972ba9e41f
Add missing versionadded ( fixes #12392 )
2011-11-05 17:55:03 +01:00
416ecffcc4
Issue #3067 : Enhance the documentation and docstring of locale.setlocale()
2011-11-05 10:18:50 +02:00
5d19b9a1e8
Fix typos
2011-11-04 14:05:52 -07:00
23ca12a981
Inline the advisory text on how to use the shelve module.
2011-11-04 13:07:52 -07:00
0fc13ae345
Fix Issue13147 - Correct the Multiprocessing Pool.map_async method signature.
...
Remove the error_callback which is not present in 2.7. Patch by Jyrki
Pulliainen.
2011-11-03 02:02:38 +08:00
7e82b276dd
#670664 : Fix HTMLParser to correctly handle the content of ``<script>...</script>`` and ``<style>...</style>``.
2011-11-01 14:09:56 +02:00
1f3b84f971
correct signature for tzinfo.dst() in examples; thanks to Daniil Shved from docs@
2011-11-01 10:31:26 +01:00
73ce5e73a6
really use backticks in string conversion definition; thanks to Jonathan Blakes from docs@
2011-10-31 19:19:26 +01:00
c4114ead71
use diveintopython.net now that DIP.org returns 410; thanks to Josh Gachnang from docs@
2011-10-31 17:45:09 +01:00
c93e413e31
remove confusing paragraph (as part of r87523); thanks to AJ Hill from docs@
2011-10-31 17:15:03 +01:00
a9db763cc0
document turtle mainloop()/done() functions; thanks to Csaba Szepesvari from docs@
2011-10-31 10:08:14 +01:00
f45501d8f8
caught is the right pp of catch; thanks to Don Bennett from docs@
2011-10-31 02:40:26 +01:00
187aa269c2
Improve itertools docs with clearer examples of pure python equivalent code.
2011-10-30 14:53:17 -07:00
59dba38166
Add a button to the code examples in the doc to show/hide the prompts and output.
2011-10-30 09:19:33 +02:00
87033526ad
Minor fixes to the HTMLParser doc.
2011-10-28 14:20:08 +03:00
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
345fff3de8
Remove mentions of previous license in profile module ( #12417 followup)
2011-07-28 22:27:28 +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
e04d256c2d
reST indentation fix in sqlite3 docs. rst uses 3 space indentation.
2011-07-03 10:12:59 -07:00
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
4601530137
#11363 : add missing functions from curses doc. Patch by Sandro Tosi.
2011-06-26 13:34:56 +03:00
14989cf4d1
#11363 : clean up curses doc.
2011-06-26 13:33:46 +03:00
99c9c8534f
#11669 : rephrase footnote in the Compound Statements page.
2011-06-26 11:25:28 +03:00
7bf5ba0f79
Fix Issue10020 - Doc update to sqlite3 module in 2.7 branch.
2011-06-25 20:48:21 -07:00
196273e1d0
Use correct markup in zipimport.rst. Patch by Sara Magliacane.
2011-06-25 19:40:06 +03:00
fd1cb59618
Issue 12086: add example showing how to use name mangling.
2011-06-25 16:28:07 +02:00
320b91495a
Issue 11889: Clarify docs for enumerate.
2011-06-25 14:57:06 +02:00
653a53fb14
Issue #12228 : Fix exchanged flag descriptions in stat.rst. Thanks Sandro Tosi.
2011-06-25 12:01:06 +02:00
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
1d3365106d
#12389 : fix missing space at sentence end.
2011-06-22 20:00:27 -04:00
832288ca18
merge 3.2 - Fix closes Issue12359 - Removing a confusing sentence from the previous change.
2011-06-20 07:34:48 -07:00
98fec3aa5e
Fix issue12359. Minor doc update on import module description.
2011-06-19 17:45:36 -07:00
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
898d43c7af
update link to pycrypto ( closes #12351 )
2011-06-16 18:49:46 -05:00
ad52cb2613
Closes #12206 : documentation update for LogRecord constructor and Formatter.formatTime.
2011-06-13 14:59:36 +01:00
761473f28a
Issue #12223 : Typo fix in datamodel docs
2011-06-10 10:36:34 +03:00
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
a65a880cd2
Add examples that work on Windows to distutils docs ( #1626300 )
2011-06-08 01:11:36 +02:00
3322a25532
Remove outdated bit of advice (c882b5ff92d9 follow-up)
2011-06-04 18:35:04 +02:00
d66d95cdd0
Document working dir for “make html” ( #12249 ). Patch by Tshepang Lekhonkhobe.
2011-06-03 19:25:58 +02:00
45b082935d
Fix named tuples to work with vars().
2011-06-02 20:40:35 -07:00
88fc66179b
Cleanup example
2011-06-01 16:01:21 -07:00
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
783a30f38e
Link to suggestions for how to use super().
2011-06-01 14:57:13 -07:00
346d8609a1
Fix markup: arguments in a class directive are __init__ arguments, not base classes
2011-05-31 21:50:22 +02:00
28ef3c4726
Re-add missing doc stub for the distutils check command
2011-05-29 00:31:30 +02:00
bee18a31ad
Backport doc improvements for distutils.cmd.Command ( #9223 ).
...
Original commit by Georg Brandl.
2011-05-29 00:11:59 +02:00
5dd034b84f
Minor doc addition for clarity
2011-05-27 04:42:47 +02:00
ec464cf9bb
Add missing reST target to one heading in the tutorial
2011-07-29 11:35:27 +02:00
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
beb9170cc4
Merge #12417 followup, also removing an extra docstring
2011-07-28 22:32:04 +02:00
18176f06b5
Fix two typos
2011-05-25 18:06:16 +02:00
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
29f6efa844
Issue 12003: fixing error in xrange alternative sample
2011-05-23 06:10:26 +03:00
e91b305d28
Issue 12126: removing incorrect claim about return value of select
2011-05-22 06:49:01 +03:00
691a659ddb
Simplify example
2011-05-21 09:39:57 -07:00
ce77defd84
this should actually be an IOError
2011-05-20 11:49:06 -05:00
30e10d8114
add example for not using access
2011-05-20 11:41:13 -05:00
52f63eabeb
#12072 : add missing parenthesis in the doc. Patch by Sandro Tosi.
2011-05-20 15:04:38 +03:00
bfbd1a2fd4
#12092 : backport rephrasing of a paragraph in the tutorial.
2011-05-17 05:39:22 +03:00
b429c57481
#12093 : fix typo in struct doc. Patch by Sandro Tosi.
2011-05-17 05:17:35 +03:00
11041f0af9
Port #6498 fix: fix several misspellings of "SystemExit" as "SystemError".
2011-05-15 08:50:32 +02:00
9b323a521c
#11979 : improve wording and markup in sockets howto. Patch by Xavier Morel.
2011-05-14 09:17:52 +03:00
073070629b
#12061 : remove duplicate glossary entry.
2011-05-12 07:47:06 +02:00
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
351761236a
Issue 12047: Expand the style guide.
2011-05-10 00:39:02 -07:00
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
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
fe12aa67fc
#11997 : fix typo in init.rst.
2011-05-05 14:19:48 +03:00
1602ec109b
Fix #11834 . Correct site-packages paths.
...
Patch by Bryce Verdier.
2011-05-03 22:01:53 -05:00
001cc954bb
#11985 : document the return value of platform.python_implementation for PyPy.
2011-05-03 20:41:48 +03:00
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
cfa8483051
Branch merge
2011-05-02 13:36:18 +02:00
941592aa19
Fix grammar to include both integer types in 2.x
2011-05-02 13:09:36 +02:00
ec0ecb1afc
Fix spelling.
2011-05-01 18:14:49 -07:00
17ebbdb73e
note abcs of int and float ( closes #11977 )
2011-05-01 17:38:17 -05:00
12b8fcfc45
Split combined code/doctest code blocks in two blocks, to enable proper highlighting.
2011-05-01 22:36:31 +02:00
2a53d33dc6
Fix wording
2011-05-01 02:15:03 +02:00
dd6ab85384
#11883 : fix email examples by adding 'localhost' to SMTP constructor calls
2011-04-30 17:26:02 -04:00
dcaacbf1ef
#11901 : post-commit review fixes per Georg Brandl
2011-04-30 16:34:35 -04:00
2a7a3ee39a
fix function name in example ( closes #11966 )
2011-04-30 13:14:56 -05:00
b22f39cb94
fix formatting, :c:func: --> :cfunc:
2011-04-30 09:02:12 +03:00
11d1171ecf
Issue #10912 : add clarification for PyObject_RichCompareBool comparing identical objects
2011-04-30 08:51:55 +03:00
bb23bd69b9
Fix #11961 . Document STARTUPINFO and creation flag options.
2011-04-29 22:23:46 -05:00
6940e61225
#11952 : Fix typo in multiprocessing doc.
2011-04-29 07:10:24 +03:00
9d68ad862a
Merged solution for #11786 from 2.6
2011-04-28 17:40:19 +02:00
22108f1bb0
Closes #11786 : ConfigParser.[Raw]ConfigParser optionxform().
2011-04-28 17:27:59 +02:00
bd0933a687
Issue #11940 : Update external link.
2011-04-27 16:34:07 -07:00
cd12746ce9
#11942 : Fix return type of Py_AddPendingCall. Patch by Sandro Tosi.
2011-04-28 00:48:46 +03:00
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
c69313a7ab
Fix some more markup glitches in argparse doc.
2011-04-22 01:29:13 +03:00
569083adbf
The \ is not supported in Sphinx 0.6.
2011-04-21 23:30:27 +03:00
d281f1439d
#11905 : fix missing full stop in argparse doc. Noticed by Vladimir Rutsky.
2011-04-21 23:09:27 +03:00
310619c80f
#11904 : fix indentation in argparse doc. Noticed by Vladimir Rutsky.
2011-04-21 23:06:48 +03:00
0a43ecc9df
#11902 : Fix typo in argparse doc. Noticed by Vladimir Rutsky.
2011-04-21 22:56:51 +03:00
01b600c2a3
Add the :mod: role where it was missing.
2011-04-21 16:12:17 +03:00
2eab88e834
#11885 : capitalize Python.
2011-04-21 15:26:46 +03:00
ffdf94ae79
Fix wrong function name. Noticed by Clive Darke.
2011-04-20 21:29:31 +03:00
b4923786fa
Fix wrong number of functions noticed by Sandro Tosi.
2011-04-19 23:12:37 +03:00
0513275b58
Updated documentation on fileConfig().
2011-04-19 13:47:23 +01:00
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
8e4eeef4ee
#11865 : fix typo in init.rst.
2011-04-18 10:11:21 +03:00
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
12125823fa
Fix a few hyphens in argparse.rst.
2011-04-16 23:04:51 +03:00
ad72bb1aa8
Issue #11855 : Apply missing formatting for urlretrieve
2011-04-16 15:28:42 +03:00
df453fbb5f
Add another example to the collections module docs.
2011-04-15 17:55:36 -07:00
65c620d0c7
#11843 : remove duplicate line from table in distutil doc.
2011-04-15 18:05:09 +03:00
6033d26118
#4783 : document that is not possible to use json.dump twice on the same stream.
2011-04-15 07:37:00 +03:00
929e276176
Issue #11827 : remove mention of list2cmdline in the doc of subprocess
2011-04-15 07:35:06 +03:00
020f6508c1
#11840 : Improve c-api/unicode documentation. Patch by Sandro Tosi.
2011-04-14 07:39:06 +03:00
7f9d2ead34
#9101 : backport json reference in configparser doc.
2011-04-14 06:53:44 +03:00
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
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
5dbca9cc3f
Issue #11794 : Reorganised logging documentation.
2011-04-08 11:40:38 +01:00
3c599bdbd1
Issue #11639 : Configuration function documentation referred to logging.XXX rather than logging.config.XXX.
2011-03-29 01:21:48 +01:00
f851fe9fc5
Issue #11639 : Configuration function documentation referred to logging.XXX rather than logging.config.XXX.
2011-03-29 01:15:37 +01:00
af1fee06c9
Issue #11639 : Configuration function documentation referred to logging.XXX rather than logging.config.XXX.
2011-03-29 01:07:50 +01:00
d113512ed5
#10617 : add class directives to collections ABCs.
2011-03-28 13:46:28 +03:00
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
3f69a059b9
Issue #8982 : Improve the documentation for the argparse Namespace object. (Merge from 3.2.)
2011-03-26 19:59:02 +01:00
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
10ab95a271
Remove untrue statement from tutorial
2011-03-26 01:26:08 +01:00
8bea9a5b13
Use universal construct os.path.expanduser('~') instead of os.environ['HOME']
2011-03-26 01:24:47 +01:00
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
405a4717e1
Issue 10787: Document the probability density function for random.gammavariate.
2011-03-22 15:52:46 -07:00
b76f6200d2
Issue 10988: fix description of super's descriptor call.
2011-03-22 15:28:45 -07:00
4fbd88a078
Fix typo spotted by Sandro Tosi
2011-03-22 21:45:42 +01:00
7250730afc
Issue #11625 : Fix Typo
2011-03-22 09:06:38 -07:00
b6dc81df2b
Fix duplicate word.
2011-03-21 08:55:16 +01:00
c75f26511b
Fix typo in class name
2011-03-20 18:34:24 +01:00
ec5b5cb489
the name of the option is a bit too low-level
2011-03-20 12:24:20 -05:00
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
c2077b0d9b
#11565 : Fix several typos. Patch by Piotr Kasprzyk.
2011-03-16 12:34:31 +02:00
ab40e4cb95
Merge #11216 : document all possible set_charset execution paths.
2011-03-15 18:01:04 -04:00
a3ed3f03d7
Issue #10885 : Fix multiprocessing docs typo
2011-03-14 10:43:36 +02:00
ad797b699d
#11484 : remove paragraph about with_traceback from 2.7 doc.
2011-03-13 22:55:41 +02:00
8b78a9d8ca
Remove documentation to non-existent function PyObject_CopyToObject ( fixes #11478 )
2011-03-13 19:35:04 +01:00
ec40bab21e
Issue #11426 : use 'with' statements on open files in CSV examples
2011-03-13 08:45:19 +02:00
dd6833d20a
Fix markup in inputoutput.rst.
2011-03-13 02:13:08 +02:00
4f1a665fae
clarify condition for readline to return EOF ( closes #11312 )
2011-03-12 17:12:54 -06:00
5ddf51f735
Fixes issue #11476 : StreamHandler parameter name change documented.
2011-03-12 22:43:23 +00:00
c3ab30b363
Fix typo.
2011-03-12 22:21:37 +02:00
Mark Dickinson
Ezio Melotti
Eli Bendersky
Vinay Sajip
Éric Araujo
Petri Lehtinen
Raymond Hettinger
Senthil Kumaran
Sandro Tosi
Nick Coghlan
Benjamin Peterson
Florent Xicluna
Antoine Pitrou
Larry Hastings
Victor Stinner
Georg Brandl
Ross Lagerwall
R David Murray
Ned Deily
Barry Warsaw
Brian Curtin
Łukasz Langa
Steven Bethard