R David Murray
69ebfe43b0
#11780 : document that email.encoders throw TypeError on multipart messages.
2012-03-16 22:03:17 -04:00
Eli Bendersky
969b8daf5a
Issue #14202 : some additional doc fixes
2012-03-16 16:49:58 +02:00
Eli Bendersky
3fb05a90ce
Issue #14202 : Greatly enhance the documentation of xml.dom.pulldom.
...
Patch by Florian Mladitsch
2012-03-16 14:37:14 +02:00
Eli Bendersky
604c4ff43d
Issue #9257 : clarify the events iterparse accepts
2012-03-16 08:41:30 +02:00
Senthil Kumaran
6b3434ae04
Explain the use of charset parameter with Content-Type header. Issue11082
2012-03-15 18:11:16 -07:00
R David Murray
38c2754652
#12758 : removing confusing mention of UTC from time.time description
...
Patch by Dylan Sarber.
2012-03-15 03:06:15 -04:00
Senthil Kumaran
87684e6eea
Fix the wrong urllib exampls which use str for POST data. Closes Issue11261
2012-03-14 18:08:13 -07:00
Georg Brandl
300a691026
Closes #14305 : fix typo.
2012-03-14 22:40:08 +01:00
Georg Brandl
525fd5447d
Closes #14289 : put a link to the CHM download page on the docs download page.
2012-03-14 08:18:47 +01:00
Georg Brandl
69c7a69cbe
Closes #14283 : match() and search() are regex methods, not match methods.
2012-03-14 08:02:43 +01:00
Senthil Kumaran
21c71bac5f
closes Issue12365 - Add an example explaining the context manager use case of urllib.urlopen
2012-03-13 19:47:51 -07:00
Senthil Kumaran
6080db7606
closes issue14257 - Grammatical fix
2012-03-12 10:05:34 -07:00
Senthil Kumaran
a7fccd8b14
closes issue14257 - 3.2 minor error in glossary wording regarding __hash__
2012-03-11 21:04:56 -07:00
Mark Dickinson
328dd0d5f3
Closes #9574 : Note that complex constructor doesn't allow whitespace around central operator.
2012-03-10 16:09:35 +00:00
Georg Brandl
64a40949cf
Closes #14186 : add link to PEP 3107 (function annotations) to the function definition section.
2012-03-10 09:22:47 +01:00
Senthil Kumaran
065dedaf47
Fix closes Issue: 14217 - 3.2 branch
2012-03-08 20:56:52 -08:00
Jason R. Coombs
30b8e5461d
Use PEP-8 style in logging example
2012-03-07 10:26:08 -05:00
Éric Araujo
e5eec7e198
Move xml.etree higher and xml.parsers.expat lower in the markup ToC.
...
I assume that most users looking at this page are looking for a library
to process XML, not a low-level parser. First proposed in #11379 .
2012-03-05 16:01:41 +01:00
Éric Araujo
fdfaf0aba2
Use source reST role instead of file where it makes sense.
...
source generates a nifty link to the Mercurial web viewer.
2012-03-05 15:50:37 +01:00
Éric Araujo
d3899e320f
Remove mention of defunct file.
...
Misc/COPYRIGHT was renamed twelve years ago to LICENSE and later copied
to the main docs, to which there is already a link.
2012-03-05 15:47:32 +01:00
Eli Bendersky
b2b18632ce
merge 3.2 heads
2012-03-02 07:43:08 +02:00
Eli Bendersky
20293441da
Issue #11379 : add a note in xml.dom.minidom suggesting to use etree in some cases
2012-03-02 07:37:13 +02:00
Petri Lehtinen
4d2bfb5e08
sqlite3: Port documentation changes from the 2.7 branch
...
Issue #13491 .
2012-03-01 21:48:38 +02:00
Ezio Melotti
443f000bdd
#14155 : remove duplication about search vs match in re doc.
2012-02-29 13:39:05 +02:00
Ezio Melotti
5a045b9f54
#10713 : Improve documentation for \b and \B and add a few tests. Initial patch and tests by Martin Pool.
2012-02-29 11:48:44 +02:00
Larry Hastings
62417a0354
Propagate changes for issues #13053 and #13086 from 2.7 to 3.2. (Doc only.)
2012-02-28 16:21:47 -08:00
Sandro Tosi
83c48822c5
s/div/truediv/; thanks to Félix-Antoine Fortin from docs@
2012-02-28 22:28:28 +01:00
Vinay Sajip
39b83ac772
Improved logging cookbook example.
2012-02-28 08:05:23 +00:00
Georg Brandl
e998386442
Fix markup errors.
2012-02-28 08:21:40 +01:00
Vinay Sajip
982f534fab
Updated cookbook with information on customising LogRecords.
2012-02-27 11:56:29 +00:00
Vinay Sajip
6b883a2c4d
Updated logging cookbook with info on alternative format styles.
2012-02-27 11:02:45 +00:00
Gregory P. Smith
3bbdc8e822
Issue #14123 : Explicitly mention that old style % string formatting has caveats
...
but is not going away any time soon.
2012-02-26 01:54:07 -08:00
Éric Araujo
f527277b67
Branch merge
2012-02-26 04:00:43 +01:00
Éric Araujo
a6091998af
Use const markup instead of a misleading string literal
2012-02-26 02:13:30 +01:00
Ezio Melotti
4342722f40
#14114 : don't include copybutton.js in the htmlhelp output.
2012-02-25 19:24:24 +02:00
Georg Brandl
e578021696
Add 3.2.3 to license.
2012-02-23 21:19:18 +01:00
Georg Brandl
eb25fb7af7
Fix markup errors.
2012-02-23 21:12:39 +01:00
Georg Brandl
7ef825fdab
merge with 3.2
2012-02-21 22:36:37 +01:00
Georg Brandl
c9a42070a6
Remove reST markup from --help output. Also: O(n**2) is dict construction, not single insertion.
2012-02-21 22:36:27 +01:00
Georg Brandl
09a7c72cad
Merge from 3.1: Issue #13703 : add a way to randomize the hash values of basic types (str, bytes, datetime)
...
in order to make algorithmic complexity attacks on (e.g.) web apps much more complicated.
The environment variable PYTHONHASHSEED and the new command line flag -R control this
behavior.
2012-02-20 21:31:46 +01:00
Georg Brandl
2daf6ae249
Issue #13703 : add a way to randomize the hash values of basic types (str, bytes, datetime)
...
in order to make algorithmic complexity attacks on (e.g.) web apps much more complicated.
The environment variable PYTHONHASHSEED and the new command line flag -R control this
behavior.
2012-02-20 19:54:16 +01:00
Vinay Sajip
fee358b0df
logging: clarified documentation for Handler.handleError.
2012-02-20 18:35:26 +00:00
Éric Araujo
c3ef037ee1
Add missing “::” markup.
...
Also wrap two looong lines.
2012-02-20 01:44:55 +01:00
Sandro Tosi
0467686e07
Issue #13605 : use print() in argparse nargs example
2012-02-19 19:54:00 +01:00
Sandro Tosi
f06d444f5a
don't split 'Hye-Shik Chang' name; thanks to Sergey from docs@
2012-02-19 12:30:28 +01:00
Sandro Tosi
76dea27421
Indent 'File' in memoryview example, so it is correctly highlighted
2012-02-19 12:28:01 +01:00
Sandro Tosi
c33ae06cbf
fix error in memoryview example; thanks to kan lianlian from docs@
2012-02-18 16:05:34 +01:00
Terry Jan Reedy
ead1de2f03
Issue 14023 Revert edit to 2.7 version. (I suspect edit is from when we thought
...
to to makes bytes mutable, before deciding to add bytearrays.)
2012-02-17 19:56:58 -05:00
Ezio Melotti
4279bc7aef
#14020 : improve HTMLParser documentation.
2012-02-18 02:01:36 +02:00
Petri Lehtinen
b3890226b3
sqlite3: Fix documentation errors concerning Cursor.rowcount
...
Closes #13995 .
2012-02-16 21:39:03 +02:00
Sandro Tosi
5cb522cb32
Issue #11836 : document multiprocessing.queues.SimpleQueue
2012-02-15 23:14:21 +01:00
Petri Lehtinen
1ca93954e1
Issue #13491 : Fix many errors in sqlite3 documentation
...
Initial patch by Johannes Vogel.
2012-02-15 22:21:01 +02:00
Éric Araujo
ccddc474c3
Improve doc for atexit.register and unregister ( #12297 )
2012-02-15 17:07:49 +01:00
Senthil Kumaran
7f728c1e1a
shutil copy module reference doc fix.
2012-02-13 23:30:47 +08:00
Gregory P. Smith
58f23ffb21
Issue #13930 : Adds ability for 2to3 to write its output to a different
...
directory tree instead of overwriting the input files. Adds three command
line options: -o/--output-dir, -W/--write-unchanged-files and --add-suffix.
Feature backports into stable release branches for 2to3 are allowed by
a special exemption:
http://mail.python.org/pipermail/python-dev/2011-December/115089.html
2012-02-12 15:50:21 -08:00
Éric Araujo
01a2215727
Update mention of Subversion in the FAQ.
...
If I grepped correctly, this was the last outdated place.
2012-02-12 04:49:45 +01:00
Nadeem Vawda
30d94b7aea
Issue #13989 : Document that GzipFile does not support text mode.
...
Also, give a more helpful error message when opened with an invalid mode string.
2012-02-11 23:45:10 +02:00
Senthil Kumaran
5b14d732d8
Issue #9021 - Introduce copy module better. Doc changes suggested by Terry
...
Reedy.
2012-02-09 18:26:59 +08:00
Senthil Kumaran
6e13f130a9
Fix Issue #6005 : Examples in the socket library documentation use sendall,
...
where relevant, instead send method.
2012-02-09 17:54:17 +08:00
Éric Araujo
cd2a6033ac
Branch merge
2012-02-05 13:41:47 +01:00
Nadeem Vawda
bd249c1bae
Clarify note in BZ2File docs about lack of multi-stream support (issue #1625 ).
2012-02-05 14:29:00 +02:00
Georg Brandl
9701eb6e14
Closes #13944 : fix capitalization of class name.
2012-02-05 09:25:22 +01:00
Nadeem Vawda
8f50912f87
Issue #1625 : Document BZ2File's lack of support for multi-stream inputs.
2012-02-04 23:44:49 +02:00
Benjamin Peterson
f51ebf94bb
threading primitives now have timeouts
2012-02-04 09:55:52 -05:00
Petri Lehtinen
9713321f46
Document absoluteness of sys.executable
...
Closes #13402 .
2012-02-02 20:59:50 +02:00
Brian Curtin
090ec3c7fc
merge. again.
2012-02-01 15:24:10 -06:00
Brian Curtin
10dda6e029
Add a hint that CSD == Service Pack.
...
People searcing for the way to get a "service pack" will never find that we
provide it here, and people that find this function won't know what CSD is
until they run the function. On top of this, they won't know what the value
means unless they really have a service pack installed.
CSD, or Customer Service Diagnostics, is apparently no longer used, and was
rarely used term at that. Most references to it online are from
universities making Windows 2000 and XP service packs available to students.
2012-02-01 15:14:00 -06:00
Raymond Hettinger
fc3ba6b8fc
Add usage note
2012-02-01 09:07:40 -08:00
Georg Brandl
c875d2032b
Fix #13900 : resolve self-referential description of a parameter.
2012-01-29 15:38:47 +01:00
Benjamin Peterson
871b9d169d
note that get() is not affected by default_factory ( closes #13887 )
2012-01-27 09:14:01 -05:00
Antoine Pitrou
04707c032e
Fix error handling in examples of C API use.
2012-01-27 14:07:29 +01:00
Antoine Pitrou
9f6b02ecde
Clarify that ssl.OP_ALL can be different from OpenSSL's SSL_OP_ALL.
2012-01-27 10:02:55 +01:00
Brett Cannon
722db7bdba
merge
2012-01-26 18:36:08 -05:00
Brett Cannon
1740afded1
Issue #13883 : Document all platforms PYTHONCASEOK works on.
2012-01-26 18:29:06 -05:00
Meador Inge
65992c1c01
- Issue #13840 : Fix ctypes.create_string_buffer exception message and docs.
2012-01-26 08:44:00 -06:00
Georg Brandl
6c89a79d55
#13852 : some small doc fixes.
2012-01-25 22:36:25 +01:00
Benjamin Peterson
b4b0b354dd
kill extra word
2012-01-25 16:30:18 -05:00
Benjamin Peterson
e9fca253d0
say bitwise (because I have no idea what a bit-string is)
2012-01-25 16:29:03 -05:00
Antoine Pitrou
5311c1d7ab
Issue #13772 : In os.symlink() under Windows, do not try to guess the link
...
target's type (file or directory). The detection was buggy and made the
call non-atomic (therefore prone to race conditions).
2012-01-24 08:59:28 +01:00
Georg Brandl
3b65fd7e97
#13816 : fix two minor style issues. Thanks to Justin Wehnes for the patch.
2012-01-23 20:19:33 +01:00
Antoine Pitrou
f49d152ab2
Issue #12922 : fix the TextIOBase documentation to include a description of seek() and tell() methods.
2012-01-21 20:20:49 +01:00
Sandro Tosi
41b2404dab
fix typo; thanks to Justin Watt from docs@
2012-01-21 10:59:37 +01:00
Meador Inge
a3443d985e
Issue #12949 : Document the kwonlyargcount argument for the PyCode_New C API function.
2012-01-19 22:06:31 -06:00
Sandro Tosi
da8e11ac71
Issue #13605 : more meaningful example + fixes
2012-01-19 22:23:00 +01:00
Sandro Tosi
16bd0b4463
Issue #13605 : add documentation for nargs=argparse.REMAINDER
2012-01-19 21:59:55 +01:00
Sandro Tosi
f0229aa51c
Issue #11948 : clarify modules search path
2012-01-19 11:29:26 +01:00
Meador Inge
972cfb9169
Issue #2134 : Clarify token.OP handling rationale in tokenize documentation.
2012-01-19 00:22:22 -06:00
Georg Brandl
c77bb65deb
Remove "documenting" latex document.
2012-01-16 21:40:12 +01:00
Sandro Tosi
32ee44ffb4
Issue: #12409 : remove obsolete susp-entries
2012-01-16 18:02:09 +01:00
Éric Araujo
f2fbb9cf42
Improve interlinking of archiving/compression modules docs.
...
- Remove duplicated list of links to the other modules from each
module’s doc (people can already go up to library/archiving and
there they can see the list).
- Link to shutil high-level operations.
Reviewed by Nadeem Vawda in #6715 .
2012-01-16 16:55:55 +01:00
Éric Araujo
6f7aa00c1e
Document json.dump ensure_ascii parameter ( #13770 )
2012-01-16 10:09:20 +01:00
Ezio Melotti
01b34afb3a
#13715 : fix typo in unicodedata doc. Patch by Eli Collins.
2012-01-16 08:42:32 +02:00
Ezio Melotti
9ecb6beb8c
#13695 : fix a couple of typos in the doc.
2012-01-16 08:28:54 +02:00
Éric Araujo
9c7b9190c3
Markup improvements for the embedding CPython doc patch from #1040439
2012-01-15 02:31:58 +01:00
Éric Araujo
9cff42736d
Hide or remove user-visible XXX notes from distutils doc ( #13716 ).
...
Requested by Florent Xicluna with the rationale that they make the docs
look unfinished. I’ve also removed a few XXX notes that were not
visible in the HTML but could waste contributors’ time by suggesting
improvements that are never going to happen for distutils.
2012-01-15 02:25:31 +01:00
Sandro Tosi
515687a7ed
remove 'Documenting Python' and its references, it's now on devguide
2012-01-14 22:23:27 +01:00
Gregory P. Smith
c1f079f317
Mention the additional way to use the lvl parameter and when it changed.
2012-01-14 12:46:17 -08:00
Terry Jan Reedy
a931463fea
#13730 grammar fix
2012-01-13 23:43:13 -05:00
Terry Jan Reedy
a3d1e2e342
#11633 At least 2 people prefer earlier revision.
2012-01-12 14:49:02 -05:00
Antoine Pitrou
889a5101c2
Issue #13724 : improve documentation for socket.create_connection.
2012-01-12 08:06:19 +01:00
Terry Jan Reedy
ea868d32a1
Minor correction. #11418
2012-01-11 14:54:34 -05:00
Terry Jan Reedy
e247928fed
Closes #11633 Clarify print buffering.
2012-01-11 14:09:49 -05:00
Terry Jan Reedy
f4ec3c5a92
#13754 String returned if less than *or equal to* x 3
...
Close *13753 'seq' now 'iterable'
2012-01-11 03:29:42 -05:00
Senthil Kumaran
19d85c2762
Issue9637 - Explain in getproxies_environment that <scheme>_proxy environ variable case does not matter.
2012-01-11 01:29:08 +08:00
Antoine Pitrou
ac8bfcacfc
Issue #13747 : fix SSL compatibility table.
2012-01-09 21:43:18 +01:00
Antoine Pitrou
84a2edcdf7
Issue #13747 : fix documentation error about the default SSL version.
2012-01-09 21:35:11 +01:00
Sandro Tosi
645a0dd6f7
Py_SetPythonHome() can be called before Py_Initialize(); thanks to Cody Smith from docs@
2012-01-07 18:34:07 +01:00
Charles-François Natali
ded0348c08
Issue #13502 : threading: Fix a race condition in Event.wait() that made it
...
return False when the event was set and cleared right after.
2012-01-07 18:24:56 +01:00
Sandro Tosi
b52e7a9a36
clarify recv* are blocking operations; thanks to Chris Kogelnik from docs@
2012-01-07 17:56:58 +01:00
Antoine Pitrou
441ae043df
Update printout of SSL certificate examples for 3.2+.
2012-01-06 20:06:15 +01:00
Sandro Tosi
f57674713a
Issue #12042 : a queue is only used to retrive results; preliminary patch by Jordan Stadler
2012-01-05 19:48:56 +01:00
Sandro Tosi
ba232dfc83
Issue #11984 : remove reference to parser, it's not showing symbol usage anymore
2012-01-05 19:06:25 +01:00
Sandro Tosi
98492a50ea
Issue #10772 : add count and help argparse action; patch by Marc Sibson
2012-01-04 23:25:04 +01:00
Antoine Pitrou
b7ffed8a50
Add a subsection explaning cipher selection.
2012-01-04 02:53:44 +01:00
Benjamin Peterson
d204934ee3
exception support is correct now ( closes #13705 )
2012-01-03 16:30:37 -06:00
Sandro Tosi
753b79c073
Issue #6031 : improve serve_forever() description
2012-01-03 22:35:54 +01:00
Sandro Tosi
ea320abcae
Issue #9349 : add argparse.SUPPRESS to help doc
2012-01-03 18:37:03 +01:00
Sandro Tosi
da785fd527
Issue #13690 : add re.DEBUG; patch by Filip Gruszczyński
2012-01-01 12:55:20 +01:00
Sandro Tosi
b2794c842f
Issue #13683 : raise with no exception in scope throws a RuntimeError; fix by Ramchandra Apte
2012-01-01 12:17:15 +01:00
Benjamin Peterson
c40d362a1c
merge heads
2011-12-31 22:42:45 -06:00
Benjamin Peterson
f606e682a4
add another year to glorious PSF IP
2011-12-31 22:42:26 -06:00
Sandro Tosi
1abde3628b
fix some broken URLs
2011-12-31 18:46:50 +01:00
Eli Bendersky
d08effe287
Some formatting & grammar fixes for the multiprocessing doc
2011-12-31 07:20:26 +02:00
Benjamin Peterson
a6c4a10d4e
indicate msg is an argument
2011-12-30 23:08:09 -06:00
Benjamin Peterson
79ed84c7f2
use booleans
2011-12-30 13:47:25 -06:00
Georg Brandl
1532c8f9a7
I do not think we will ever have auto-indent at the prompt, that is for IPython and the like.
2011-12-25 19:03:07 +01:00
Sandro Tosi
7386662699
use list() to wrap range() in itertools.permutations() example; thanks to Romain MORLEVAT from docs@
2011-12-25 17:25:45 +01:00
Sandro Tosi
3e6c814b9d
fix "Title underline too short" sphinx warning
2011-12-25 17:14:11 +01:00
Sandro Tosi
2b373b0146
use double-quote char instead of unicode ones; thanks to tomo cocoa from docs@
2011-12-25 17:07:22 +01:00
Sandro Tosi
44f568c21f
fix to sent/send typo
2011-12-25 11:44:38 +01:00
Sandro Tosi
1526ad166e
fix Constuctor/Constructor typo; thanks to Anthon van der Neut from docs@
2011-12-25 11:27:37 +01:00
Sandro Tosi
3721fbc5de
point IronPython to ironpython.net; thanks to Lazar Pancic from docs@
2011-12-24 23:13:19 +01:00
Sandro Tosi
75c71ccf2a
fix Rather that/Rather than; thanks to Reuben Thomas from docs@
2011-12-24 19:56:04 +01:00
Sandro Tosi
baf30da240
remove spurious dot from string formatting example; thanks to Anthon van der Neut from docs@
2011-12-24 15:53:35 +01:00
Sandro Tosi
0b7e5369f1
correct syslog.openlog() argument name to logoption; thanks to Arnaud Gomes-do-Vale from docs@
2011-12-24 14:51:49 +01:00
Meador Inge
ac007ba686
Issue #13632 : Update token documentation to reflect actual token types
2011-12-23 22:30:16 -06:00
Benjamin Peterson
57f97f400b
parameter_list was meant here
2011-12-23 20:01:43 -06:00
Benjamin Peterson
ad17358a2f
kill superfluous 'comprehension' case ( closes #13658 )
2011-12-23 20:00:56 -06:00
Senthil Kumaran
016c6d5341
Issue12798 - Update mimetypes documentation. Correct the doc section where
...
common_types was mentioned under MimeTypes class, move it to helper function
category and other documentation improvements contributed by Sandro Tosi.
2011-12-23 10:52:42 +08:00
Antoine Pitrou
08c08eb93c
Issue #13597 : Fix the documentation of the "-u" command-line option, and wording of "What's new in Python 3.0" about standard streams.
2011-12-21 11:24:15 +01:00
Benjamin Peterson
0f1e3ac897
note the blinding speed of these functions
2011-12-20 10:12:41 -06:00
Benjamin Peterson
1c92cfea4a
don't mention implementation detail
2011-12-19 16:41:11 -05:00
Ezio Melotti
80a61e8d4c
#13387 : rephrase unclear sentence.
2011-12-19 07:04:48 +02:00
Victor Stinner
6fbd525ef5
Issue #13617 : Document that the result of the conversion of a Unicode object to
...
wchar*, Py_UNICODE* and bytes may contain embedded null characters/bytes.
Patch written by Arnaud Calmettes.
2011-12-18 19:22:31 +01:00
Victor Stinner
a94a0e92b8
Issue #13522 : Fix _Py_co_pow() documentation
...
Patch written by Arnaud Calmettes.
2011-12-18 02:56:18 +01:00
Antoine Pitrou
07b1c877b2
Issue #13522 : document error return values of some float and complex C API functions.
2011-12-18 01:25:27 +01:00
Victor Stinner
e83f899364
Issue #13530 : Document os.lseek() result
...
Patch written by Jérémy Anger.
2011-12-17 23:15:09 +01:00
Ezio Melotti
e5b2ac8987
#13613 : fix example in re doc.
2011-12-17 01:17:17 +02:00
Antoine Pitrou
7158e06212
Issue #13597 : Improve documentation of standard streams.
2011-12-15 16:25:34 +01:00
Ezio Melotti
7b7e39a61f
#6570 : clarify tutorial section about keyword arguments.
2011-12-13 15:49:22 +02:00
Ezio Melotti
91621e2c16
#13549 : improve tutorial section about listcomps.
2011-12-13 15:36:19 +02:00
Lars Gustäbel
0c6cbbd632
Fix doc typo.
2011-12-10 12:45:45 +01:00
Antoine Pitrou
432259feea
Issue #13528 : rework the performance question in the programming FAQ
2011-12-09 23:10:31 +01:00
Antoine Pitrou
5b73ca4b3d
s/SOCKSTREAM/TCP/
2011-12-05 01:46:35 +01:00
Antoine Pitrou
8e644f0e7c
Reword IPC section
2011-12-05 01:43:32 +01:00
Antoine Pitrou
8345451170
Use www.python.org instead of a hostname pointing to a parked (or squatted) domain.
...
Also, reformat a bit.
2011-12-05 01:37:34 +01:00
Antoine Pitrou
fa03f6c863
Remove the outdated notion that multithreading doesn't work well on Unices.
2011-12-05 01:32:29 +01:00
Antoine Pitrou
534e253cb6
Remove reference to the base64 encoding.
2011-12-05 01:21:46 +01:00
Antoine Pitrou
48a7cbf7c2
The functional module hasn't been maintained since 2006 and doesn't work with Python 3.
...
Remove section about it from the functional programming FAQ.
2011-12-05 01:05:32 +01:00
Antoine Pitrou
ae44b7a099
Remove obsolete references to bsddb
2011-12-05 00:41:19 +01:00
Antoine Pitrou
c1bd4896cf
Issue #13527 : remove mention of Python megawidgets and Tkinter3000 WCK
...
from the doc. These two projects appear dead.
2011-12-04 23:56:30 +01:00
Georg Brandl
6a96a2e1f8
Fix typo.
2011-12-04 11:51:21 +01:00
Antoine Pitrou
dec0f21efc
Streamline mention of sorted()
2011-12-03 23:08:57 +01:00
Antoine Pitrou
c561a9adac
Break down and refine memory management question
2011-12-03 23:06:50 +01:00
Antoine Pitrou
17bd792cd3
Reformulate answer, and remove off-topic discussion of bytecode in a question about compiling to C.
2011-12-03 22:56:02 +01:00
Antoine Pitrou
cc809a286a
Fix compatibility statement.
2011-12-03 22:39:13 +01:00
Antoine Pitrou
748799a0a6
Remove outdated question (the bsddb module isn't included anymore)
2011-12-03 22:37:14 +01:00
Antoine Pitrou
d4ddec5988
Refine FAQ entry for catching stdout
2011-12-03 22:35:31 +01:00
Antoine Pitrou
48383bfc67
Advocate PyTuple_Pack instead of manual building of tuples
2011-12-03 22:30:19 +01:00
Antoine Pitrou
f35204055e
Remove outdate FAQ content
2011-12-03 22:19:55 +01:00
Antoine Pitrou
c5b266efb5
Streamline FAQ entry about the ternary operator, and suggest using io.StringIO for a mutable unicode container.
2011-12-03 22:11:11 +01:00
Antoine Pitrou
9cb41dfbaa
Remove references to psyco, which is mostly unmaintained and doesn't work with Python 3.
2011-12-03 21:21:36 +01:00
Antoine Pitrou
5dd95d6f2d
Mention PySide in the "other GUIs" page.
2011-12-03 21:07:01 +01:00
Antoine Pitrou
7462e87134
Mention the new GTK+ 3 bindings.
2011-12-03 20:59:24 +01:00
Meador Inge
777bebb0ef
Issue #13513 : IOBase docs incorrectly link to the readline module
2011-12-03 12:29:54 -06:00
Jason R. Coombs
a90e364ea5
Issue #12666 : Added section about map changes.
2011-12-03 08:24:21 -05:00
Jason R. Coombs
df9a5f5ecf
Issue #12666 : Clarifying changes in map for Python 3
2011-08-01 17:51:34 -04:00
Ezio Melotti
c1f26f6fc1
#13494 : s/cast/convert/. Also add a link.
2011-12-02 19:47:24 +02:00
Ezio Melotti
b1b3fd23b7
#13499 : fix example adding >>> before the comments.
2011-12-02 19:28:36 +02:00
Antoine Pitrou
71bca3495d
Issue #1040439 : better document how to compile and link an embedded Python interpreter.
...
Still lacks docs for Windows (anyone?).
2011-11-30 21:19:21 +01:00
Éric Araujo
c4d7d8c49d
Mark up constants in sockets docs as such
2011-11-29 16:46:38 +01:00
Éric Araujo
2bddc53cb9
Fix typo ( #13467 )
2011-11-29 16:34:58 +01:00
Antoine Pitrou
fd9ebd4a36
Clarify concatenation behaviour of immutable strings, and remove explicit
...
mention of the CPython optimization hack.
2011-11-25 16:33:53 +01:00
Eli Bendersky
5a53f368e6
fix some typos in Doc/c-api/memoryview.rst
2011-11-25 15:07:50 +02:00
Vinay Sajip
631a7e23c5
Added a configuration dictionary example to the logging cookbook.
2011-11-23 14:27:54 +00:00
Vinay Sajip
287f24691d
Closes #13459 : Clarified documentation on Logger.propagate. Thanks to Mike Fogel for the patch.
2011-11-23 08:54:22 +00:00
Amaury Forgeot d'Arc
3b1acf11e9
bytes() can't be used to get a representation of an object.
2011-11-22 19:34:08 +01:00
Mark Dickinson
b1e58fe43f
Issue #12245 : Document sys.float_info.rounds better.
2011-11-19 16:26:45 +00:00
Ezio Melotti
fabf0275a9
#13387 : add note about checking the exact type in assertIsInstance doc.
2011-11-18 18:59:36 +02:00
Ezio Melotti
e62aad3073
#13426 : fix typos in pickle doc.
2011-11-18 13:51:10 +02:00
Eli Bendersky
eeae1498aa
fixing typos in optparse doc
2011-11-16 06:02:21 +02:00
Éric Araujo
04e6909845
Fix markup
2011-11-14 18:00:48 +01:00
Eli Bendersky
d44af82e62
Issue #12767 : documenting threading.Condition.notify
2011-11-12 20:44:25 +02:00
Florent Xicluna
599d76b275
Reformat paragraphs.
2011-11-11 19:56:26 +01:00
Florent Xicluna
45c6c3eb71
Few typos in the documentation.
2011-11-11 19:55:21 +01:00
Eli Bendersky
a7795dbe9a
Issue #13191 : typo in argparse docs
2011-11-11 10:57:01 +02:00
Eli Bendersky
c2c896093b
Issue #13365 : correct an error in the documentation of str.expandtabs
2011-11-11 10:40:14 +02:00
Nick Coghlan
32e4a58c06
Issue #13237 : Fix formatting error - the legacy shell commands weren't meant to be under the Notes heading
2011-11-08 21:50:58 +10:00
Nick Coghlan
69ce0d8602
Issue #13237 : Remove duplicate data value descriptions from the subprocess docs
2011-11-08 21:39:07 +10:00
Nick Coghlan
c29248f232
Issue #13237 : Forward port subprocess module updates and explicitly document UTF-8 encoding assumption when universal_newlines=True
2011-11-08 20:49:23 +10:00
Éric Araujo
06c42a3fca
Document that shutil.make_archive does not typecheck its logger argument
2011-11-07 17:31:07 +01:00
Petri Lehtinen
395ca72380
Issue #3067 : Enhance the documentation and docstring of locale.setlocale()
2011-11-05 10:21:16 +02:00
Éric Araujo
9c2f42f253
Branch merge
2011-11-03 16:27:57 +01:00
Éric Araujo
a083823a85
Avoid relying on the default reST role in logging library doc
2011-11-03 04:35:20 +01:00
Éric Araujo
3bb1a6f990
State explicitely that PYTHONDONTWRITEBYTECODE is equivalent to -B
2011-11-03 03:20:43 +01:00
Victor Stinner
2662133a05
Issue #10570 : curses.tigetstr() is now expecting a byte string, instead of a
...
Unicode string.
This is an incompatible change, but the previous behaviour was completly wrong.
2011-11-02 23:45:29 +01:00
Ezio Melotti
7de56f6a04
#670664 : Fix HTMLParser to correctly handle the content of ``<script>...</script>`` and ``<style>...</style>``.
2011-11-01 14:12:22 +02:00
Sandro Tosi
4bfe03a42e
correct signature for tzinfo.dst() in examples; thanks to Daniil Shved from docs@
2011-11-01 10:32:05 +01:00
Sandro Tosi
53bcd66012
use diveintopython.net now that DIP.org returns 410; thanks to Josh Gachnang from docs@
2011-10-31 17:46:04 +01:00
Sandro Tosi
69e59a17dd
remove confusing paragraph (as part of r87523); thanks to AJ Hill from docs@
2011-10-31 17:15:39 +01:00
Sandro Tosi
e348455f5f
document turtle done() function; thanks to Csaba Szepesvari from docs@
2011-10-31 10:12:43 +01:00
Sandro Tosi
567493fe26
caught is the right pp of catch; thanks to Don Bennett from docs@
2011-10-31 02:41:06 +01:00
Raymond Hettinger
6f45d18c24
Improve itertools docs with clearer examples of pure python equivalent code.
2011-10-30 15:06:14 -07:00
Ezio Melotti
f54f6f520d
Add a button to the code examples in the doc to show/hide the prompts and output.
2011-10-30 09:20:19 +02:00
Florent Xicluna
305bb662a9
Documentation typo
2011-10-28 22:14:41 +02:00
Florent Xicluna
83386dac8b
I should be someone
2011-10-28 22:03:55 +02:00
Ezio Melotti
f99e4b5dbe
Improve HTMLParser example in the doc and fix a couple minor things.
2011-10-28 14:34:56 +03:00
Ezio Melotti
0b85cd0680
Merge heads.
2011-10-28 12:32:53 +03:00
Ezio Melotti
d3cf0db3ee
#13278 : fix typo.
2011-10-28 12:22:25 +03:00
Florent Xicluna
74e6495a20
Fixes #13270 : obsolete reference to old-style/new-style classes.
2011-10-28 11:21:19 +02:00
Vinay Sajip
6187664fa7
Added lost documentation cross-reference.
2011-10-27 17:50:55 +01:00
Ezio Melotti
fbb39815d4
Refactor a bit the codecs doc.
2011-10-25 10:40:38 +03:00
Ezio Melotti
963004d1d8
Fix typo.
2011-10-25 09:41:13 +03:00
Benjamin Peterson
1fafc1a11f
document __bytes__ special method ( closes #13259 )
2011-10-25 00:03:51 -04:00
Benjamin Peterson
d6ca6c2b32
note callable is back in 3.2
2011-10-24 08:51:15 -04:00
Florent Xicluna
023611f34e
Issue 13141: Demonstrate recommended style for socketserver examples.
2011-10-23 22:40:37 +02:00
Petri Lehtinen
ce77037503
Add the green "New reference" note to the doc of PyException_GetTraceback()
2011-10-23 21:03:33 +03:00
Ezio Melotti
cd1d3ef77b
#13233 : fix typo.
2011-10-20 19:51:18 +03:00
Ezio Melotti
81231d9379
#13219 : clarify section about character sets in the re documentation.
2011-10-20 19:38:04 +03:00
Raymond Hettinger
af37b89240
Issue 12668: Fix wording in Whatsnew3.2
2011-10-19 14:16:18 -07:00
Raymond Hettinger
5768e0c788
Issue 11931: Minor punctuation/grammar/wording fixups to the regex docs
2011-10-19 14:10:07 -07:00
Senthil Kumaran
29fa9d4d68
3.2 - 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:46:00 +08:00
Ezio Melotti
e130a52d8a
Remove duplication.
2011-10-19 10:58:56 +03:00
Ezio Melotti
67494f2224
#12277 : add missing comma.
2011-10-18 12:59:39 +03:00
Éric Araujo
9be57231dd
Update dead references from py.org/dev/faq to the devguide ( #13176 )
2011-10-14 17:37:45 +02:00
Mark Dickinson
f1ab47ebc4
Issue #13145 . Fix incorrect documentation for PyNumber_ToBase. Thanks Sven Marnach.
2011-10-11 18:06:36 +01:00
Ezio Melotti
4e15828640
Fix/improve markup in whatsnew/2.7.
2011-10-10 00:30:14 +03:00
Ezio Melotti
138fc896c8
#13138 : add missing versionadded.
2011-10-10 00:02:03 +03:00
Raymond Hettinger
df7c4cde48
Clean-up and improve the priority queue example in the heapq docs.
2011-10-09 17:28:14 +01:00
Éric Araujo
47a4521ece
Fix distutils byte-compilation to comply with PEP 3147 ( #11254 ).
...
Patch by Jeff Ramnani. Tested with -B, -O and -OO.
2011-10-08 00:34:13 +02:00
Éric Araujo
35a502b324
Fix a typo and a broken link (part of #10536 ).
...
Found by Franz Glasner in #2504 .
2011-10-07 22:02:58 +02:00
Antoine Pitrou
f394e47851
Issue #12823 : remove broken link and replace it with another resource.
2011-10-07 16:58:07 +02:00
Éric Araujo
bb2095f1e2
Branch merge
2011-10-06 13:10:34 +02:00
Senthil Kumaran
ad87fa6719
Issue #13073 - Address the review comments made by Ezio.
2011-10-05 23:26:49 +08:00
Éric Araujo
58a9153c9f
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 '3.2' is a CPython detail and
should not be advertised (see #9442 ), even if some stdlib modules
currently rely on that detail.
2011-10-05 01:28:24 +02:00
Éric Araujo
da27263b4a
Move doc of sys.dont_write_bytecode to make all attributes sorted again
2011-10-05 01:17:38 +02:00
Senthil Kumaran
5d0de3fbaa
Document message_body arg in HTTPConnection.endheaders
2011-10-03 07:27:06 +08:00
Ezio Melotti
35ec7f771b
#13076 : fix links to datetime.time and datetime.datetime.
2011-10-02 12:44:50 +03:00
Senthil Kumaran
17dac4c0e2
Fix closes issue13005 - Remove the mention of 'repeat' method in the operator module documentation.
2011-09-22 02:09:17 +08:00
Georg Brandl
1d678f8413
Fix bug in heapq priority queue example.
2011-09-18 07:40:05 +02:00
Georg Brandl
73dd7c71f6
Add info from the docstring for random.gammavariate() to the docs.
2011-09-17 20:36:28 +02:00
Georg Brandl
755460694e
Fix typo.
2011-09-17 20:20:04 +02:00
Ezio Melotti
4165bfb6e9
#12940 : fix cmd example. Patch by Tim Chase.
2011-09-10 10:06:01 +03:00
Éric Araujo
eb933de807
Fix current name of the Python 3 binary on Unix ( #12896 ).
...
Also fix some markup and typos.
2011-09-09 19:03:41 +02:00
Vinay Sajip
4eb0e73ff2
Closes #12906 : Fixed bug in YAML configuration.
2011-09-06 14:07:23 +01:00
Senthil Kumaran
e969a2117c
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:21:30 +08:00
Georg Brandl
3484a8771c
Merge with release clone.
2011-09-04 08:35:54 +02:00
Łukasz Langa
7335e6f3e8
removed misleading editing leftovers
2011-09-02 23:17:39 +02:00
Sandro Tosi
fbd4fe2195
Give credit to Adam
2011-09-02 21:24:40 +02:00
Sandro Tosi
172f374a63
#12781 : Mention SO_REUSEADDR flag near socket examples
2011-09-02 20:06:31 +02:00
Éric Araujo
d9e1789364
Branch merge
2011-09-02 17:30:36 +02:00
Éric Araujo
18ddf826e7
Add links from library/functions to other docs.
...
Suggested by Terry J. Reedy in #12298 .
2011-09-01 23:10:36 +02:00
Éric Araujo
9edd9f035b
Fix a few links in the table of built-in functions ( #12298 )
2011-09-01 23:08:55 +02:00
Éric Araujo
29cf58c9d5
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 18:59:06 +02:00
Éric Araujo
8ab3a1d735
Document that True/False/None don’t use :keyword: in doc.
...
This was discussed some months ago on python-dev. Having tons of links
to the definition of True would be annoying, contrary to links to e.g.
the nonlocal or with statements doc.
2011-09-01 18:45:50 +02:00
Ezio Melotti
222b20844f
From RFC 3629 5- and 6-bytes UTF-8 sequences are invalid, so remove them from the doc.
2011-09-01 08:11:28 +03:00
Ross Lagerwall
a9353db2cd
Remove duplicate text in os documentation.
2011-09-01 06:58:52 +02:00
Éric Araujo
ec9a5f6399
Add version number for versionchanged directive (backport from 3.3)
2011-09-01 05:55:26 +02:00
Éric Araujo
7af8ebb6ce
Adapt/remove mentions of functions gone in 3.x
2011-09-01 03:20:13 +02:00
Éric Araujo
37b5f9eebc
Fix some misuses of Sphinx roles and one typo
2011-09-01 03:19:30 +02:00
Éric Araujo
941afedd74
Avoid using the default reST role. Makes Doc/tools/rstlint.py happy.
2011-09-01 02:47:34 +02:00
Éric Araujo
be573e7d17
Remove outdated pointer to optparse ( fixes #11360 ).
...
The doc already points to argparse.
2011-08-26 16:38:40 +02:00
Éric Araujo
77443824f5
Document the "optional" argument of distutils’ Extension class
2011-08-26 00:45:18 +02:00
Éric Araujo
3f5e958a3f
Fix type information in distutils API reference ( #9302 ).
...
Initial patch by Yue Shuaijie.
2011-08-26 00:44:37 +02:00
Éric Araujo
cc42ebe450
Make the list of docs contributors sorted again
2011-08-26 00:10:12 +02:00
Georg Brandl
e1eef41a18
Close #12838 : fix range() call.
2011-08-25 11:52:26 +02:00
Antoine Pitrou
13d2895dbf
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:48:43 +02:00
Sandro Tosi
9daf98d32a
#12787 : link original MultiCall proposal to webarchive and in a footnote
2011-08-20 17:05:56 +02:00
Georg Brandl
2513123d66
Update suspicious ignore file.
2011-09-03 09:28:05 +02:00
Georg Brandl
a47e53e42e
Update sys.platform doc for #12326 .
2011-09-03 09:26:09 +02:00
Łukasz Langa
987b188615
removed misleading editing leftovers
2011-09-02 23:17:39 +02:00
Sandro Tosi
335f204977
#12781 : Mention SO_REUSEADDR flag near socket examples
2011-09-02 20:06:31 +02:00
Éric Araujo
d86ac4cd4e
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 18:59:06 +02:00
Éric Araujo
7bb769c092
Add version number for versionchanged directive (backport from 3.3)
2011-09-01 05:55:26 +02:00
Éric Araujo
f3c7822ee5
Adapt/remove mentions of functions gone in 3.x
2011-09-01 03:20:13 +02:00
Éric Araujo
43ba354599
Fix some misuses of Sphinx roles and one typo
2011-09-01 03:19:30 +02:00
Éric Araujo
217607ecde
Remove outdated pointer to optparse ( fixes #11360 ).
...
The doc already points to argparse.
2011-08-26 16:38:40 +02:00
Éric Araujo
72dde45dc6
Document the "optional" argument of distutils’ Extension class
2011-08-26 00:45:18 +02:00
Georg Brandl
852eea20ef
Close #12838 : fix range() call.
2011-08-25 11:52:26 +02:00
Antoine Pitrou
dc42beb55e
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:48:43 +02:00
Sandro Tosi
6a633bb878
fix description of \r; thanks to Thomas Waldmann from docs@
2011-08-19 22:54:50 +02:00
Sandro Tosi
e1043fc230
fix description of \r; thanks to Thomas Waldmann from docs@
2011-08-19 22:54:50 +02:00
Sandro Tosi
2f394f6666
mention RFC1123 as origin of 4-year digit; thanks to John Haxby from docs@
2011-08-19 18:40:21 +02:00
Sandro Tosi
f693810f69
mention RFC1123 as origin of 4-year digit; thanks to John Haxby from docs@
2011-08-19 18:40:21 +02:00
Éric Araujo
57bee66c03
Branch merge
2011-08-19 14:22:28 +02:00
Éric Araujo
355d48ad83
Typo
2011-08-19 09:28:46 +02:00
Éric Araujo
04ac59a22a
Mention virtual subclasses in the glossary entry for ABCs ( #12256 ).
...
I added a link from the term “virtual subclass” to the glossary entry
for ABCs but this was not enough, now the glossary briefly defines
“virtual” and links to the abc module doc which contains more mentions
of virtual subclasses.
2011-08-19 09:07:46 +02:00
Eli Bendersky
f6854cb0f0
Issue #12672 : remove confusing part of sentence in documentation
2011-08-19 06:29:51 +03:00
Eli Bendersky
729a42f263
Issue #12672 : remove confusing part of sentence in documentation
2011-08-19 06:29:51 +03:00
Éric Araujo
4d71a66a01
Fix typo in command name
2011-08-19 03:44:36 +02:00
Éric Araujo
a2d26182e2
Fix instance I missed in 59f7bbe1236c ( #1626300 )
2011-08-19 03:12:38 +02:00
Éric Araujo
e197df06fb
Remove obsolete term + indicate how to find the program ( #1626300 ).
...
Suggested by Terry J. Reedy.
2011-08-19 02:30:15 +02:00
Éric Araujo
e8b7eb07e1
Link isinstance/issubclass to the ABC glossary entry ( #12256 )
2011-08-19 02:17:03 +02:00
Éric Araujo
543edbdab8
Don’t quote characters twice.
...
``code`` markup is enough to mark command-line fragments or to talk
about a character. ``'c'`` is still used for actual Python string
objects. I did a similar change in optparse.rst in r86521.
I’ve also ported two minor changes from the 3.3 version of the file
(removing an unnecessary module name in a class directive, adding a
comma).
2011-08-19 01:45:12 +02:00
Éric Araujo
fde9242631
Don’t use “arg” for “argument”
2011-08-19 01:30:26 +02:00
Éric Araujo
19f9b71ffe
Add a few missing source links from 2.7 and harmonize lib docs headers
2011-08-19 00:49:18 +02:00
Éric Araujo
d001ffe745
Minor improvements to BadZipFile and BadZipfile docs.
...
I made the doc for the compat alias BadZipfile shorter and used a
directive to document deprecation.
I figured there was no point of talking about zipfile.error (“the old
name” that’s older than the other old name BadZipfile) in the 3.x docs
so I just removed it.
2011-08-19 00:44:31 +02:00
Éric Araujo
5eada94163
Fix markup to get a target instead of a comment
2011-08-19 00:41:23 +02:00
Éric Araujo
889a7dcb3a
Fix a typo and touch up blank lines
2011-08-19 00:40:46 +02:00
Éric Araujo
6e7d0ba309
Add missing reST target for one section of this file
2011-08-19 00:39:57 +02:00
Éric Araujo
0519b09936
Avoid splitting a word between a link and text
2011-08-19 00:39:19 +02:00
Sandro Tosi
b2761186af
#12761 : fix wording of zlib license section
2011-08-16 20:03:11 +02:00
Sandro Tosi
f6b25b9e35
#12761 : fix wording of zlib license section
2011-08-16 20:03:11 +02:00
Ezio Melotti
0656a56214
#12204 : document that str.upper().isupper() might be False and add a note about cased characters.
2011-08-15 14:27:19 +03:00
Ezio Melotti
f42121f27e
#12725 : fix working. Patch by Ben Hayden.
2011-08-14 08:28:57 +03:00
Ezio Melotti
388c945e97
#12725 : fix working. Patch by Ben Hayden.
2011-08-14 08:28:57 +03:00
Georg Brandl
96d237c40a
Update versions in LICENSE files.
2011-08-13 11:59:12 +02:00
Georg Brandl
1db1d14e11
Update pydoc topics and suspicious ignore.
2011-08-13 11:33:35 +02:00
Sandro Tosi
7bf4363f77
let PySequence_Check me a link; thanks to tomo cocoa from docs@
2011-08-13 00:39:46 +02:00
Sandro Tosi
8a3b657f9e
it's 'rather than'; reported by James Bateman on docs@
2011-08-12 19:31:32 +02:00
Éric Araujo
28d39a0c08
Branch merge
2011-08-12 17:40:25 +02:00
Vinay Sajip
817495a631
Issue #12718 : Add documentation on using custom importers.
2011-08-11 13:45:48 +01:00
Éric Araujo
d9d7bca6da
Use real word in English text (i.e. not code)
2011-08-10 04:19:03 +02:00
Benjamin Peterson
77c4fd01dd
note mutating tp_dict is bad ( closes #12719 )
2011-08-09 16:07:01 -05:00
Éric Araujo
da3f4ae34b
Branch merge
2011-08-09 18:01:38 +02:00
Georg Brandl
bdbdfb1978
Confirm that the prime example is actually correct. We get so many complaints about a "buggy example" on docs@python, let us hope this cuts them in half at least.
2011-08-08 21:45:13 +02:00
Éric Araujo
54a1d05877
Branch merge
2011-08-08 16:56:00 +02:00
Sandro Tosi
db79e95195
#12709 : add error_callback argument to map_async documentation
2011-08-08 16:38:13 +02:00
Sandro Tosi
61baee0ee7
#10741 : add documentation for PyGILState_GetThisThreadState()
2011-08-08 00:16:54 +02:00
Sandro Tosi
2a389e4601
#12677 : correct turtle orientation in doc
2011-08-07 17:12:19 +02:00
Éric Araujo
6ef038e78c
Add documentation for PEP 370 features in distutils ( #10745 ).
...
This started out as an easy task, just add a section describing this
alternate scheme, but I found a lot of cleanup to do along the way:
- fixed inverted reST targets
- fixed entries for modules (hi abiflags!) or data files
- avoided duplicating the same options listing five or six times
- added missing entries for C headers locations
- added documentation for --install-lib
- fixed a few misuses of the option role (see #9312 ), but not all (not
worth the time, but will do it in packaging docs)
- fixed some markup
The paths fixes were done with an eye on the source code in the install
command, so they really describe what’s actually done. The situation on
Mac OS X is rather messy: the fix for #8084 touched site and sysconfig,
but distutils doesn’t use these files. I suspect we have a mismatched
stdlib at the moment, and the fix is not even clear (see the bug report
for further discussion).
2011-08-06 16:30:42 +02:00
Eli Bendersky
ebd4805df0
Fix grammar
2011-08-06 09:31:09 +03:00
Senthil Kumaran
2e0153550c
Fix closes Issue12697 - Update the usage syntax of timeit module in the docs.
2011-08-06 13:37:04 +08:00
Senthil Kumaran
a3b2316a1b
merge from 2.7 - Fix closes issue11047 - Correct the 2.7 whatsnew description for issue 7902.
2011-08-06 12:54:23 +08:00
Éric Araujo
de4f05b741
Improve documentation for PEP 370 support in site module ( #8617 ).
...
site.USER_BASE and site.USER_SITE are now fully documented. PEP 370 is
outdated with respects to the Mac framework situation, but the code in
sysconfig and the example in the 3.2 What’s New document helped me find
the right values to document for Mac OS X.
The command-line interface of the site module, partly documented in the
3.2 What’s New, is fully described in the module docs.
The purpose of the usercustomize module is explained in the site docs,
with a gentle introduction in the tutorial (right after the section that
talks about PYTHONSTARTUP; a comment mentions it should be moved from
the tutorial to another file, but that will be another bug).
Various markup and wording improvements were made along the way in the
site module docs. Duplicate and incomplete declarations of environment
variables have also been removed (the original bug report was actually
about these entries :). The site module docs are still a bit messy;
I’ll see about improving them for #11553 .
All these sections are copiously interlinked and findable from the doc
indexes.
2011-08-06 01:51:07 +02:00
Senthil Kumaran
86a1a8974d
Fix closes issue12663 - Correcting the ArgumentParser.error description. Patch by Sandro Tosi.
2011-08-03 07:42:18 +08:00
Sandro Tosi
2a8d195328
#12665 : Dictionary view example has error in set operation
2011-08-02 18:42:04 +02:00
Sandro Tosi
692dba244b
#12670 : Fix struct code after forward declaration on ctypes doc
2011-08-02 16:17:14 +02:00
Senthil Kumaran
ef5c716176
Fix closes Issue12183 - Explain the Symlink copy behavior in shutil.copytree. Patch by Petri Lehtinen.
2011-08-02 18:52:28 +08:00
Georg Brandl
aa71583f09
Use attribute access instead of index access for namedtuple.
2011-08-01 22:58:53 +02:00
Éric Araujo
2ffea0e8d7
Branch merge
2011-08-01 14:43:45 +02:00
Vinay Sajip
952595696a
Closes #12667 : Added documentation for SMTPHandler secure argument.
2011-08-01 11:31:52 +01:00
Ezio Melotti
222e61e444
Fix typo reported by Sandro Tosi.
2011-07-31 22:49:18 +03:00
Éric Araujo
ab7c1b3f11
Fix regression with distutils MANIFEST handing ( #11104 , #8688 ).
...
The changed behavior of sdist in 3.1 broke packaging for projects that
wanted to use a manually-maintained MANIFEST file (instead of having a
MANIFEST.in template and letting distutils generate the MANIFEST).
The fixes that were committed for #8688 (76643c286b9f by Tarek and
d54da9248ed9 by me) did not fix all issues exposed in the bug report,
and also added one problem: the MANIFEST file format gained comments,
but the read_manifest method was not updated to handle (i.e. ignore)
them. This changeset should fix everything; the tests have been
expanded and I successfully tested the 2.7 version with Mercurial, which
suffered from this regression.
I have grouped the versionchanged directives for these bugs in one place
and added micro version numbers to help users know the quirks of the
exact version they’re using.
Initial report, thorough diagnosis and patch by John Dennis, further
work on the patch by Stephen Thorne, and a few edits and additions by
me.
2011-07-31 04:06:12 +02:00
Ezio Melotti
592563292c
#12531 : Fix spaces and markup.
2011-07-30 21:25:22 +03:00
Benjamin Peterson
497cd65cec
add space
2011-07-30 09:59:50 -05:00
Benjamin Peterson
50211fa0f9
document NotImplemented
2011-07-30 09:57:24 -05:00
Eli Bendersky
b603b27775
merging Georg's revision
2011-07-30 11:36:41 +03:00
Eli Bendersky
e250358062
Issue #11699 : fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen
2011-07-30 11:14:32 +03:00
Georg Brandl
eea6cda91a
Change test.support docs to be more specific about the nature of this module.
2011-07-30 09:00:48 +02:00
Eli Bendersky
7bd081c117
Issue #12531 : add index entries to documentation of * and ** in function calls
2011-07-30 07:05:16 +03:00
Éric Araujo
fe1e298d8b
Document that atexit execution order is undefined ( #9788 )
2011-07-29 18:04:24 +02:00
Éric Araujo
63b18a4445
Add a link target for argparse.Namespace ( #8982 )
2011-07-29 17:59:17 +02:00
Éric Araujo
e801aa2a1d
Let the doc of __import__ link to importlib ( #9254 ).
...
importlib.import_module eschews a number of issues that __import__ has.
Reviewed by Brett Cannon. (The docstring of __import__ was already
updated in 3d490c3a019e, for #7397.)
2011-07-29 17:50:58 +02:00
Éric Araujo
158d7696f3
Branch merge
2011-07-29 14:24:08 +02:00
Eli Bendersky
ef4902af87
Issue #12644 : document the '%a' conversion in the old string formatting operations. Patch prepared together with Ezio Melotti
2011-07-29 09:30:42 +03:00
Éric Araujo
cf534817ad
Branch merge
2011-07-28 23:08:11 +02:00
Éric Araujo
fc662ddda2
Merge profile docs followup ( #12417 ) from 3.1
2011-07-28 23:00:14 +02:00
Éric Araujo
ee19c772cb
Remove mentions of previous license in profile module docs ( #12417 followup).
...
Also remove an extra docstring.
2011-07-28 22:56:24 +02:00
Éric Araujo
f5e10d1f70
Turn raw URI into real link
2011-07-28 22:50:18 +02:00
Éric Araujo
14382dc887
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-28 22:49:11 +02:00
Éric Araujo
72db3459e4
Make indentation comply with our style guide and the rest of the file
2011-07-26 16:54:24 +02:00
Éric Araujo
59e387eb40
Fix “anyways” (following R. David Murray in 4d5a546b6186)
2011-07-26 16:53:17 +02:00
Éric Araujo
7c12bae717
Fix reST references
2011-07-26 15:14:35 +02:00
Ross Lagerwall
59c01edcaa
Issue #12102 : Document that buffered files must be flushed before being used
...
with mmap. Patch by Steffen Daode Nurpmeso.
2011-07-25 07:12:43 +02:00
Georg Brandl
06ad13ee7c
Fix function name: open -> urlopen.
2011-07-23 08:04:40 +02:00
Ezio Melotti
bca31b5d1f
#11435 : link to the correct branch.
2011-07-21 09:35:19 +03:00
Senthil Kumaran
96c84a4c7d
Fix closes issue12524 - update http.client POST example with a working example.
2011-07-20 21:56:24 +08:00
Senthil Kumaran
ae4a78b0a8
Fix closes issue12577 - clarify shutil.move documentation. Patch suggestion by Catalin Iacob
2011-07-19 08:03:02 +08:00
Antoine Pitrou
0e752dd3f8
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
b899007268
Better English.
2011-07-18 12:38:03 -04:00
Senthil Kumaran
3e7f33fc82
fix whitespace nit.
2011-07-18 07:17:20 +08:00
Senthil Kumaran
0215d09ca9
Fix closes Issue12478 - HTTPErrorProcess 's methods are http_response and https_response.
2011-07-18 07:12:40 +08:00
Senthil Kumaran
ed270fab64
Fix closes Issue12479 - Add HTTPErrorProcessor class definition - Patch by Sandro Tosi
2011-07-18 06:42:46 +08:00
Senthil Kumaran
023c6f703d
Fix Issue10403 - datetime documentation clarification based on review in the reitveld by Alexendar belopolsky.
2011-07-17 19:01:14 +08:00
Senthil Kumaran
ad3882a2b0
Fix closes Issue11436 - Minor clarification to struct documentation for 's' format character.
2011-07-17 17:29:17 +08:00
Ned Deily
58e3350bd4
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:07:04 -07:00
Antoine Pitrou
fd060474e3
Make it clear that PyNumber_AsSsize_t() returns -1 on error.
2011-07-13 21:02:22 +02:00
Georg Brandl
325eb470b7
Clarify that PyErr_NewException creates an exception *class*, not instance.
2011-07-13 15:59:24 +02:00
Antoine Pitrou
b3593cada2
Use infinitive, not 3rd person of present tense.
2011-07-11 01:39:19 +02:00
Antoine Pitrou
6f5dcb1ee2
Issue #12343 : Add some notes on behaviour of non-blocking SSL sockets.
2011-07-11 01:35:48 +02:00
Antoine Pitrou
cdddf2b875
Mention logging.captureWarnings in the warnings module doc.
2011-07-09 21:29:36 +02:00
Antoine Pitrou
462d1b39a4
Move sys.subversion at the right place in alphabetical order, and informally deprecate it.
2011-07-09 16:02:19 +02:00
Antoine Pitrou
a83cdaae89
Issue #12326 : document the recommended idiom for checking sys.platform on Unix systems.
...
Also, point to the various alternatives.
2011-07-09 15:54:23 +02:00
Victor Stinner
6e2e3b9e81
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:26:39 +02:00
Senthil Kumaran
3aac179498
Fix whitespace nit in datetime and os rst files.
2011-07-04 11:43:51 -07:00
Senthil Kumaran
a6bac95a3c
issue10403 - Let's not use members anymore. Use 'attribute' where it denotes attribute and 'methods' where it denotes methods. Context should clarify usage.
2011-07-04 11:28:30 -07:00
Georg Brandl
bfd1edd155
Merge 3.2.1 release clone changes into main 3.2 branch after 3.2.1rc2 release.
2011-07-04 19:55:22 +02:00
Senthil Kumaran
946eb865a3
reST indentation fix in sqlite3 docs. rst uses 3 space indentation.
2011-07-03 10:17:22 -07:00
Georg Brandl
f069100d0d
Fix bad markup.
2011-07-03 09:39:49 +02:00
Georg Brandl
7f3cd98beb
Fix target path in message.
2011-07-03 09:30:42 +02:00
Mark Dickinson
40d9ebe031
Issue #12228 : Fix exchanged flag descriptions in stat.rst. Thanks Sandro Tosi.
2011-06-25 12:03:33 +02:00
Senthil Kumaran
fe9230aac6
Fix closes issue12261 - Minor documention changes in the urllib.parse.rst
2011-06-19 13:52:49 -07:00
R David Murray
ac4e5abc78
#12147 : make send_message correctly handle Sender and Resent- headers.
...
Original patch by Nicolas Estibals. My tweaks to the patch were mostly
style/cosmetic, and adding more tests.
2011-07-02 21:03:19 -04:00
Ned Deily
3eb67d58d6
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-28 00:00:28 -07:00
Raymond Hettinger
b34705ff37
Issue #8890 : Remove /tmp from examples.
2011-06-26 15:29:06 +02:00
Ezio Melotti
4850d52b4d
#11363 : add missing functions from curses doc. Patch by Sandro Tosi.
2011-06-26 13:34:56 +03:00
Ezio Melotti
b6b7371329
#11363 : clean up curses doc.
2011-06-26 13:38:11 +03:00
Ezio Melotti
fc3db8a91e
#11669 : rephrase footnote in the Compound Statements page.
2011-06-26 11:25:28 +03:00
Ezio Melotti
54cc5fd72d
Use correct markup in zipimport.rst. Patch by Sara Magliacane.
2011-06-25 19:40:06 +03:00
Raymond Hettinger
6ddefd7916
Issue 12086: add example showing how to use name mangling.
2011-06-25 16:30:39 +02:00
Raymond Hettinger
9d3df6d508
Issue 11889: Clarify docs for enumerate.
2011-06-25 15:00:14 +02:00
Mark Dickinson
7e4b5c6773
Merge #12228
2011-06-25 12:04:08 +02:00
Raymond Hettinger
4d5208d2e2
Fix typo (reported by Hiro Ashiya).
2011-06-25 11:39:00 +02:00
R David Murray
24eb4bc5c9
#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:26:13 -04:00
Senthil Kumaran
4707a998e4
Fix closes Issue12359 - Removing a confusing sentence from the previous change.
2011-06-20 07:30:34 -07:00
Senthil Kumaran
656df5ec3e
Fix closes issue 12360 - correcting parameter names in asyncore documentation.
2011-06-19 18:22:33 -07:00
Senthil Kumaran
150857028c
minor space nit.
2011-06-19 17:41:33 -07:00
Senthil Kumaran
5c0347b398
Fix closes Issue12359 - Minor update to module import description.
2011-06-19 17:37:06 -07:00
Senthil Kumaran
fd8d7e9b0d
Whitespace nit fixed using reident.
2011-06-19 16:59:41 -07:00
Senthil Kumaran
ce9b596c04
Fix closes Issue12315 - Updates to http.client documentation.
2011-06-19 16:56:49 -07:00
Senthil Kumaran
a977acc0fe
merge from 3.1 for issue issue12261.
2011-06-19 13:55:48 -07:00
R David Murray
409c32f47c
#6771 : fix docs: curses.wrapper is exposed as a function, not a module
...
Patch by July Tikhonov.
2011-06-18 19:34:12 -04:00
Benjamin Peterson
b4cfa3ad63
merge heads
2011-06-16 18:51:24 -05:00
Benjamin Peterson
a08eb73b4a
update link to pycrypto ( closes #12351 )
2011-06-16 18:49:46 -05:00
Raymond Hettinger
a63d45c825
Fix typo.
2011-06-16 22:32:10 +01:00
Éric Araujo
8ddf7c2d2b
Minor wording improvement
2011-06-15 17:49:20 +02:00
Vinay Sajip
cdc751720e
Updated Formatter.formatTime documentation.
2011-06-12 11:44:28 +01:00
Vinay Sajip
0aaa9e1d7b
Issue #12206 : documentation for LogRecord constructor updated re. the level argument.
2011-06-11 23:03:37 +01:00
Éric Araujo
9fbfe15c86
Add missing reST target to one heading in the tutorial
2011-06-11 10:34:19 +02:00
Vinay Sajip
645e4589b1
Documented change for Issue #12168 .
2011-06-10 18:52:50 +01:00
Éric Araujo
d2f8cec885
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-08 05:29:39 +02:00
Éric Araujo
96deb7550e
Add links from builtins module docs to built-in functions and constants docs
2011-06-08 04:53:20 +02:00
Éric Araujo
b805c47138
Add examples that work on Windows to distutils docs ( #1626300 )
2011-06-08 01:11:36 +02:00
Éric Araujo
b8f2ad0380
Remove outdated bit of advice (584f9c213a6d follow-up)
2011-06-08 00:47:49 +02:00
Éric Araujo
fa088dbd0c
Improve glossary entry for ABCs.
...
- Rename reST target name for collections ABCs to avoid collisions
- Add link to importlib ABCs (collections, numbers and io ABCs were already
linked)
- Link to glossary entry from numbers module doc (other modules already do it)
2011-06-04 18:42:38 +02:00
Éric Araujo
07e58c3389
Remove link that’s already present at the top of the file
2011-06-03 20:43:42 +02:00
Éric Araujo
98e68adc7e
Document working dir for “make html” ( #12249 ). Patch by Tshepang Lekhonkhobe.
2011-06-03 19:25:58 +02:00
Raymond Hettinger
3d89057ff8
Fix named tuples to work with vars().
2011-06-02 23:40:24 -07:00
Raymond Hettinger
9028928156
Forward port doc updates for builtin functions.
2011-06-01 16:17:23 -07:00
Éric Araujo
affcf2967f
Branch merge
2011-06-01 19:39:27 +02:00
Benjamin Peterson
2e3a38a774
demote this to a note
2011-05-31 21:27:41 -05:00
Éric Araujo
5864b9fd3c
Fix markup: arguments in a class directive are __init__ arguments, not base classes
2011-05-31 21:50:38 +02:00
Éric Araujo
75e86a678c
Merge 3.1
2011-05-29 18:07:12 +02:00
Éric Araujo
4b8f6651f0
Branch merge
2011-05-29 18:05:53 +02:00
Éric Araujo
87418afb3b
Fix typo in 0311f62714f7
2011-05-29 03:48:49 +02:00
Éric Araujo
6a21f5527c
Don’t misuse “package data” in pprint example
2011-05-29 03:46:31 +02:00
Éric Araujo
c5069e0070
Merge doc touch-ups and fixes for #9831 and #9223 from 3.1
2011-05-29 00:29:56 +02:00
Éric Araujo
456ae893d7
Re-add missing doc stub for the distutils check command
2011-05-29 00:22:06 +02:00
Éric Araujo
000893fab2
Minor touch-ups in distutils.cmd.Command doc
2011-05-29 00:14:45 +02:00
Éric Araujo
f33de71514
Minor doc addition for clarity
2011-05-27 04:42:47 +02:00
Éric Araujo
e0854f9dbf
Add missing closing paren
2011-05-27 04:36:52 +02:00
Éric Araujo
d4701f4262
Fix two typos
2011-05-25 18:13:29 +02:00
Raymond Hettinger
4b244ef255
Clean-up example.
2011-05-23 12:45:34 -07:00
Eli Bendersky
2f1b3962a2
Issue 12126: removing incorrect claim about return value of select
...
merge 3.1 -> 3.2
2011-05-22 06:57:17 +03:00
Eli Bendersky
46ab96a0c8
Issue 12126: removing incorrect claim about return value of select
2011-05-22 06:56:15 +03:00
Raymond Hettinger
f9ca76f500
Simplify example
2011-05-21 09:33:45 -07:00
Georg Brandl
9c1928f0a9
Merge release branch after 3.2.1rc1.
2011-05-21 17:35:33 +02:00
Benjamin Peterson
619323c68f
merge 3.1
2011-05-20 11:49:19 -05:00
Benjamin Peterson
2340986fe0
this should actually be an IOError
2011-05-20 11:49:06 -05:00