Éric Araujo
c3cc2acb09
Improve interlinking of archiving/compression modules docs.
...
- Remove duplicate 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-02-26 01:10:14 +01:00
Sandro Tosi
8b48c66ebd
Issue #13999 : refer to multiprocessing.Queue when needed
2012-02-25 19:35:16 +01:00
Ezio Melotti
f5ea48fd3b
#14114 : don't include copybutton.js in the htmlhelp output.
2012-02-25 19:24:24 +02:00
Georg Brandl
66e565ee48
merge with 2.6
2012-02-21 22:38:31 +01:00
Georg Brandl
3aec568e6e
Remove reST markup from --help output. Also: O(n**2) is dict construction, not single insertion.
2012-02-21 22:36:27 +01:00
Benjamin Peterson
aee9dfba4a
merge 2.6 with hash randomization fix
2012-02-20 21:44:56 -05:00
Barry Warsaw
1e13eb084f
- Issue #13703 : oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
...
environment variable, to provide an opt-in way to protect against denial of
service attacks due to hash collisions within the dict and set types. Patch
by David Malcolm, based on work by Victor Stinner.
2012-02-20 20:42:21 -05:00
Vinay Sajip
7d13cd3f5d
logging: clarified documentation for Handler.handleError.
2012-02-20 18:34:07 +00:00
Éric Araujo
bb42f5ed7f
Add missing “::” markup and wrap overlong lines
2012-02-20 02:08:01 +01:00
Sandro Tosi
09c05fde63
don't split 'Hye-Shik Chang' name; thanks to Sergey from docs@
2012-02-19 12:29:43 +01:00
Sandro Tosi
8d38fcf5a9
Refer to 'time' and 'datetime' submodules; thanks to Erik Johnson from docs@
...
This is needed after the move to Sphinx 1.x and it's the same way 3.x braches
managed it.
2012-02-18 20:28:35 +01:00
Ezio Melotti
c39b552603
#14020 : improve HTMLParser documentation.
2012-02-18 01:46:04 +02:00
Petri Lehtinen
002b202009
Fix errors in sqlite3's Cursor.rowcount documentation
...
Closes #13995 .
2012-02-16 21:42:34 +02:00
Sandro Tosi
c0b1172459
Issue #11836 : document multiprocessing.queues.SimpleQueue
2012-02-15 22:39:52 +01:00
Éric Araujo
d9756beb87
Improve doc for atexit.register ( #12297 )
2012-02-15 17:08:34 +01:00
Senthil Kumaran
ef18737b7f
shutil copy module reference doc fix.
2012-02-13 23:17:45 +08:00
Gregory P. Smith
12426998ce
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:51:21 -08:00
Éric Araujo
46652326be
Update mention of Subversion repo in the FAQ
2012-02-12 04:54:43 +01:00
Éric Araujo
4ad7f7f31a
distutils 2.7’s Extension does not support optional ( #13865 ).
...
Reported by Miki Tebeka.
2012-02-10 05:31:28 +01:00
Senthil Kumaran
59e7c8f177
Issue #9021 : Add an introduction to the copy module. Doc changes suggested by Terry Reedy.
2012-02-09 18:22:01 +08:00
Senthil Kumaran
607e31eddf
Fix Issue #6005 : Examples in the socket library documentation use sendall,
...
where relevant, instead send method. Patch contributed by Brian Brazil.
2012-02-09 17:43:31 +08:00
Nadeem Vawda
d15c5a869d
Clarify note in BZ2File docs about lack of multi-stream support (issue #1625 ).
2012-02-05 14:27:01 +02:00
Georg Brandl
922ae2c931
Closes #13944 : fix capitalization of class name.
2012-02-05 09:25:22 +01:00
Nadeem Vawda
acd51f9ea9
Issue #1625 : Document BZ2File's lack of support for multi-stream inputs.
2012-02-04 23:43:25 +02:00
Petri Lehtinen
fe6f9d0edc
Document absoluteness of sys.executable
...
Closes #13402 .
2012-02-02 21:26:05 +02:00
Raymond Hettinger
65de77ed9e
Clean-up docs for input()
2012-02-02 00:52:33 -08:00
Raymond Hettinger
6d837a3769
Add pure python equivalent code for reduce().
2012-02-02 00:48:46 -08:00
Raymond Hettinger
c5f310c827
Clarify the note for UserList
2012-02-01 19:00:09 -08:00
Raymond Hettinger
1d23199791
Use validate SQL in the example (this was confusing to readers)
2012-02-01 13:41:11 -08:00
Raymond Hettinger
81a55c01b8
Show the import in the sqlite3 example
2012-02-01 13:32:45 -08:00
Brian Curtin
3c8807bd5e
merge.
2012-02-01 15:22:50 -06:00
Brian Curtin
b4bef305fd
merge from fb225c289bf0
2012-02-01 15:17:39 -06:00
Raymond Hettinger
6ab9813605
Use xrange in the example
2012-02-01 08:55:21 -08:00
Raymond Hettinger
9f55b63060
fix whitespace
2012-02-01 08:54:14 -08:00
Raymond Hettinger
bdb7fe4c84
Add a usage note
2012-02-01 08:52:44 -08:00
Georg Brandl
1d8e6fd45e
Fix #13900 : resolve self-referential description of a parameter.
2012-01-29 15:38:47 +01:00
Benjamin Peterson
78028b0589
note that get() is not affected by default_factory ( closes #13887 )
2012-01-27 09:14:01 -05:00
Brett Cannon
64b2b6a84d
Issue #13883 : Document all platforms PYTHONCASEOK works on.
2012-01-26 18:32:24 -05:00
Benjamin Peterson
0a15103d79
merge heads
2012-01-25 16:43:54 -05:00
Benjamin Peterson
dcd37e8154
forgot to resolve this conflict...
2012-01-25 16:43:26 -05:00
Georg Brandl
e9401a0476
#13852 : some small doc fixes.
2012-01-25 22:36:25 +01:00
Benjamin Peterson
af90a40445
kill extra word
2012-01-25 16:30:18 -05:00
Benjamin Peterson
bcd6f3994c
say bitwise (because I have no idea what a bit-string is)
2012-01-25 16:29:03 -05:00
Georg Brandl
dfdc46f274
#13816 : fix two minor style issues. Thanks to Justin Wehnes for the patch.
2012-01-23 20:19:33 +01:00
Antoine Pitrou
8fc732f088
Issue #12922 : fix the TextIOBase documentation to include a description of seek() and tell() methods.
2012-01-21 20:27:59 +01:00
Ezio Melotti
51ab3519d8
Move a space.
2012-01-21 16:40:03 +02:00
Sandro Tosi
2d71e5c6b9
fix typo; thanks to Justin Watt from docs@
2012-01-21 10:59:12 +01:00
Georg Brandl
27a4918c99
Fix conf.py for Sphinx 1.0.
2012-01-21 08:58:22 +01:00
Terry Jan Reedy
0bb1251e1a
whitespace
2012-01-21 00:32:23 -05:00
Terry Jan Reedy
96a0a46353
Issue13820 as and with really became keywords in 2.6.
...
Original rewording by Jim Jewett
2012-01-21 00:24:25 -05:00
Sandro Tosi
cb21227407
Issue #13605 : more meaningful example + fixes
2012-01-19 22:22:35 +01:00
Sandro Tosi
10f047dca8
Issue #13605 : add documentation for nargs=argparse.REMAINDER
2012-01-19 21:59:34 +01:00
Sandro Tosi
d53abd3154
Issue #11948 : clarify modules search path
2012-01-19 11:28:15 +01:00
Meador Inge
da747c3d97
Issue #2134 : Clarify token.OP handling rationale in tokenize documentation.
2012-01-19 00:17:44 -06:00
Sandro Tosi
25e76bdb69
file.next() doc refers to itself
2012-01-17 18:57:30 +01:00
Sandro Tosi
03c6110b21
revert part of cefe4f38fa0e, as agreed with Éric
2012-01-17 18:32:02 +01:00
Sandro Tosi
6008a8b5ba
Issue: #12409 : remove obsolete susp-entries
2012-01-16 18:01:55 +01:00
Ezio Melotti
8eab1fdc8b
#13715 : fix typo in unicodedata doc. Patch by Eli Collins.
2012-01-16 08:42:32 +02:00
Ezio Melotti
055d70d588
#13695 : fix a couple of typos in the doc.
2012-01-16 08:21:24 +02:00
Sandro Tosi
bde7eacd85
fix typo; thanks to Jan Heidbrink from docs@
2012-01-15 16:34:29 +01:00
Sandro Tosi
7d77c6f6e0
remove 'Documenting Python' and its references, it's now on devguide
2012-01-14 22:22:54 +01:00
Georg Brandl
c86bb00ee5
Fix label names.
2012-01-14 17:06:53 +01:00
Sandro Tosi
9a5606886c
how could I have missed :cmember: in import.rst?
2012-01-14 16:51:16 +01:00
Sandro Tosi
a76bb03c55
None is not a keyword, link file.next() to functions.html#next
2012-01-14 16:43:14 +01:00
Sandro Tosi
d6e87f43d6
update part of sphinxext
2012-01-14 16:42:21 +01:00
Sandro Tosi
98ed08f24e
update to new C roles and directives
2012-01-14 16:42:02 +01:00
Sandro Tosi
bbd41d0874
update Sphinx reference from 0.6.7 to 1.0.7
2012-01-14 16:41:26 +01:00
Terry Jan Reedy
150122a5a2
#11633 about buffering of print
2012-01-14 00:06:37 -05:00
Terry Jan Reedy
4ba76b68b9
closes #13730
2012-01-13 23:41:31 -05:00
Antoine Pitrou
2d047e85b7
Merge
2012-01-12 08:09:15 +01:00
Antoine Pitrou
d716c73d03
Issue #13724 : improve documentation for socket.create_connection.
2012-01-12 08:06:19 +01:00
Terry Jan Reedy
477a06c142
Minor correction. Closes #11418
2012-01-11 14:51:07 -05:00
Terry Jan Reedy
1d79eb6abe
Closes #13754 String returned if less than *or equal to* x 3
2012-01-11 03:19:28 -05:00
Senthil Kumaran
8070ddcd9b
port to 2.7 - Issue9637 - Details that case of Proxy env var does not matter.
2012-01-11 01:35:02 +08:00
Raymond Hettinger
a0ff91cac0
Fix stock symbol for Microsoft
2012-01-10 09:51:51 +00:00
Raymond Hettinger
c766b31dbc
Update the sorting howto to reflect the PEP 8 advisory to define all six rich comparisons.
2012-01-10 07:55:17 +00:00
Antoine Pitrou
df4c986f9e
Issue #13747 : fix SSL compatibility table.
2012-01-09 21:43:18 +01:00
Antoine Pitrou
4a7e0c896c
Issue #13747 : fix documentation error about the default SSL version.
2012-01-09 21:35:11 +01:00
Sandro Tosi
e5f93ef268
Py_SetPythonHome() can be called before Py_Initialize(); thanks to Cody Smith from docs@
2012-01-07 18:32:06 +01:00
Sandro Tosi
f788cf70f8
clarify recv* are blocking operations; thanks to Chris Kogelnik from docs@
2012-01-07 17:56:43 +01:00
Raymond Hettinger
36cdca1277
Clarify that vars() doesn't place extra restrictions on __dict__.
2012-01-05 23:23:52 -08:00
Sandro Tosi
24f207e99e
Issue #12042 : a queue is only used to retrive results; preliminary patch by Jordan Stadler
2012-01-05 19:48:30 +01:00
Sandro Tosi
7f418f67a8
Issue #11984 : remove reference to parser, it's not showing symbol usage anymore
2012-01-05 19:05:44 +01:00
Sandro Tosi
8b211fc123
Issue #10772 : add count and help argparse action; patch by Marc Sibson
2012-01-04 23:24:48 +01:00
Sandro Tosi
499718de49
Issue #6031 : improve serve_forever() description
2012-01-03 22:35:41 +01:00
Sandro Tosi
711f54798c
Issue #9349 : add argparse.SUPPRESS to help doc
2012-01-03 18:31:51 +01:00
Sandro Tosi
8448dfa17d
Issue #13302 : backport part of 3ed28f28466f
2012-01-01 23:41:44 +01:00
Sandro Tosi
e827c13566
Issue #13690 : add re.DEBUG; patch by Filip Gruszczyński
2012-01-01 12:52:24 +01:00
Benjamin Peterson
5f8d60647b
add another year to glorious PSF IP
2011-12-31 22:42:26 -06:00
Sandro Tosi
117e1f00a8
fix some broken URLs
2011-12-31 18:13:59 +01:00
Eli Bendersky
4b76f8a76c
Some formatting & grammar fixes for the multiprocessing doc
2011-12-31 07:05:12 +02:00
Benjamin Peterson
c016f46df5
use booleans
2011-12-30 13:47:25 -06:00
Georg Brandl
2c9eee1af9
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
44585bd347
fix "Title underline too short" sphinx warning
2011-12-25 17:13:10 +01:00
Sandro Tosi
a4d06e7bc8
use double-quote char instead of unicode ones; thanks to tomo cocoa from docs@
2011-12-25 17:05:30 +01:00
Sandro Tosi
4526273d7f
fix to sent/send typo
2011-12-25 11:43:37 +01:00
Sandro Tosi
dbcbd101e7
fix Constuctor/Constructor typo; thanks to Anthon van der Neut from docs@
2011-12-25 11:27:22 +01:00
Sandro Tosi
238612a003
point IronPython to ironpython.net; thanks to Lazar Pancic from docs@
2011-12-24 23:13:08 +01:00
Sandro Tosi
ec53eb817a
fix Rather that/Rather than; thanks to Reuben Thomas from docs@
2011-12-24 19:55:49 +01:00
Sandro Tosi
4fbad84cb6
remove spurious dot from string formatting example; thanks to Anthon van der Neut from docs@
2011-12-24 15:52:36 +01:00
Sandro Tosi
55ae12b019
correct syslog.openlog() argument name to logoption; thanks to Arnaud Gomes-do-Vale from docs@
2011-12-24 14:51:26 +01:00
Senthil Kumaran
17fbe402d4
porting mimetype doc changes from 3.2.
...
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 11:08:31 +08:00
Senthil Kumaran
a9091d2611
Issue13443 - Remove the functional module examples from 2.7 (as module is
...
maintained only till 2.5 and tests had failures with 2.7) and update the links
int the howto document.
2011-12-22 23:44:53 +08:00
Benjamin Peterson
587c7381c7
note the blinding speed of these functions
2011-12-20 10:12:41 -06:00
Benjamin Peterson
5879ca1fd9
don't mention implementation detail
2011-12-19 16:41:11 -05:00
Ezio Melotti
2d679a42bf
s/:c:type:/:ctype:/g
2011-12-19 07:17:08 +02:00
Ezio Melotti
d0ffcd601e
#3932 : suggest passing unicode to HTMLParser.feed().
2011-12-19 07:15:26 +02:00
Ezio Melotti
080b6f071f
#13387 : rephrase unclear sentence.
2011-12-19 07:04:48 +02:00
Victor Stinner
28a545e234
Issue #13617 : Document that the result PyUnicode_AsUnicode() and
...
PyUnicode_AsWideChar() may contain embedded null characters.
Patch written by Arnaud Calmettes.
2011-12-18 19:39:53 +01:00
Victor Stinner
cc1a0865f1
Issue #13522 : Fix _Py_co_pow() documentation
...
Patch written by Arnaud Calmettes.
2011-12-18 02:56:18 +01:00
Antoine Pitrou
c9e180043c
Issue #13522 : document error return values of some float and complex C API functions.
2011-12-18 01:25:27 +01:00
Ezio Melotti
13c82d00c4
#13613 : fix example in re doc.
2011-12-17 01:17:17 +02:00
Ezio Melotti
05a7f0dcac
#6570 : clarify tutorial section about keyword arguments.
2011-12-13 15:49:22 +02:00
Ezio Melotti
4a72d1a661
#13549 : improve tutorial section about listcomps.
2011-12-13 14:50:21 +02:00
Antoine Pitrou
22da68b1b0
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
Meador Inge
5295718399
Issue #13513 : IOBase docs incorrectly link to the readline module
2011-12-03 12:13:42 -06:00
Ezio Melotti
2692be9d20
#13494 : s/cast/convert/. Also add a link.
2011-12-02 19:47:24 +02:00
Ezio Melotti
c2ed44f4f2
#13499 : fix example adding >>> before the comments.
2011-12-02 19:26:48 +02:00
Vinay Sajip
da75dd2a9b
Added a configuration dictionary example to the logging cookbook.
2011-11-23 14:27:11 +00:00
Vinay Sajip
3639807a79
Closes #13459 : Clarified documentation on Logger.propagate. Thanks to Mike Fogel for the patch.
2011-11-23 08:51:35 +00:00
Raymond Hettinger
421467f8f0
Note the store_true and store_false also create the appropriate defaults.
2011-11-20 11:05:23 -08:00
Mark Dickinson
b19284f6eb
Issue #12245 : Document sys.float_info.rounds better.
2011-11-19 16:26:08 +00:00
Ezio Melotti
aa512f05a4
#13387 : add note about checking the exact type in assertIsInstance doc.
2011-11-18 18:59:36 +02:00
Ezio Melotti
ba41c6a1c3
#13426 : fix typo in pickle doc.
2011-11-18 13:41:58 +02:00
Eli Bendersky
9efddb654b
fixing typos in optparse doc
2011-11-16 06:01:14 +02:00
Eli Bendersky
ea4dcd33e5
remove duplicated paragraph in the tutorial
2011-11-16 05:54:07 +02:00
Eli Bendersky
eb7113888e
Normalize the keyword arguments documentation notation in re.rst. Closes issue #12875
2011-11-14 01:02:20 +02:00
Eli Bendersky
3a8501e71f
Closes issue 12767: document the argument of threading.Condition.notify
2011-11-12 20:51:54 +02:00
Eli Bendersky
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
Eli Bendersky
bba1dd5332
Issue #13191 : typo in argparse docs
2011-11-11 16:42:11 +02:00
Vinay Sajip
5df091a91e
Closes issue #13353 : version doumentation about utc parameter corrected.
2011-11-06 22:37:17 +00:00
Éric Araujo
972ba9e41f
Add missing versionadded ( fixes #12392 )
2011-11-05 17:55:03 +01:00
Petri Lehtinen
416ecffcc4
Issue #3067 : Enhance the documentation and docstring of locale.setlocale()
2011-11-05 10:18:50 +02:00
Raymond Hettinger
5d19b9a1e8
Fix typos
2011-11-04 14:05:52 -07:00
Raymond Hettinger
23ca12a981
Inline the advisory text on how to use the shelve module.
2011-11-04 13:07:52 -07:00
Senthil Kumaran
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
Ezio Melotti
7e82b276dd
#670664 : Fix HTMLParser to correctly handle the content of ``<script>...</script>`` and ``<style>...</style>``.
2011-11-01 14:09:56 +02:00
Sandro Tosi
1f3b84f971
correct signature for tzinfo.dst() in examples; thanks to Daniil Shved from docs@
2011-11-01 10:31:26 +01:00
Sandro Tosi
73ce5e73a6
really use backticks in string conversion definition; thanks to Jonathan Blakes from docs@
2011-10-31 19:19:26 +01:00
Sandro Tosi
c4114ead71
use diveintopython.net now that DIP.org returns 410; thanks to Josh Gachnang from docs@
2011-10-31 17:45:09 +01:00
Sandro Tosi
c93e413e31
remove confusing paragraph (as part of r87523); thanks to AJ Hill from docs@
2011-10-31 17:15:03 +01:00
Sandro Tosi
a9db763cc0
document turtle mainloop()/done() functions; thanks to Csaba Szepesvari from docs@
2011-10-31 10:08:14 +01:00
Sandro Tosi
f45501d8f8
caught is the right pp of catch; thanks to Don Bennett from docs@
2011-10-31 02:40:26 +01:00
Raymond Hettinger
187aa269c2
Improve itertools docs with clearer examples of pure python equivalent code.
2011-10-30 14:53:17 -07:00
Ezio Melotti
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
Ezio Melotti
87033526ad
Minor fixes to the HTMLParser doc.
2011-10-28 14:20:08 +03:00
Ezio Melotti
f9cc80d601
Improve HTMLParser example in the doc.
2011-10-28 14:14:34 +03:00
Ezio Melotti
24c51809cf
#13278 : fix typo.
2011-10-28 12:22:25 +03:00
Vinay Sajip
e6fda8575e
Added lost documentation cross-reference.
2011-10-27 17:51:13 +01:00
Nick Coghlan
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