Mark Dickinson
328dd0d5f3
Closes #9574 : Note that complex constructor doesn't allow whitespace around central operator.
2012-03-10 16:09:35 +00: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
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
Sandro Tosi
83c48822c5
s/div/truediv/; thanks to Félix-Antoine Fortin from docs@
2012-02-28 22:28:28 +01: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
a6091998af
Use const markup instead of a misleading string literal
2012-02-26 02:13:30 +01:00
Georg Brandl
eb25fb7af7
Fix markup errors.
2012-02-23 21:12:39 +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
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
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
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
9f6b02ecde
Clarify that ssl.OP_ALL can be different from OpenSSL's SSL_OP_ALL.
2012-01-27 10:02:55 +01: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
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
Meador Inge
972cfb9169
Issue #2134 : Clarify token.OP handling rationale in tokenize documentation.
2012-01-19 00:22:22 -06: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
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
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
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
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
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
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
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
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
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
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
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
Lars Gustäbel
0c6cbbd632
Fix doc typo.
2011-12-10 12:45:45 +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
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
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
É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
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
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
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
e348455f5f
document turtle done() function; thanks to Csaba Szepesvari from docs@
2011-10-31 10:12:43 +01:00
Raymond Hettinger
6f45d18c24
Improve itertools docs with clearer examples of pure python equivalent code.
2011-10-30 15:06:14 -07: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
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
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
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
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
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
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