Sandro Tosi
13c598b1d8
Issue #14448 : mention pytz; patch by Andrew Svetlov
2012-04-24 19:43:33 +02:00
Sandro Tosi
466a5f20f1
Issue #14554 : correct example for captured_stdout()
2012-04-24 18:38:59 +02:00
Sandro Tosi
3f0f5776cd
Issue #13478 : document timeit.default_timer()
2012-04-24 18:11:29 +02:00
Sandro Tosi
45c6a3cae7
Issue #13587 : use the right RFC2617 name for WWW-Authenticate; patch by Aaron Maenpaa
2012-04-24 17:36:14 +02:00
Raymond Hettinger
e65753e09e
merge
2012-04-23 21:26:58 -07:00
Raymond Hettinger
ce0e0c7671
Improve section heading for better discoverability.
2012-04-23 21:26:35 -07:00
Raymond Hettinger
4c8d392bc1
Reorder the entries to put the type specific technique last.
2012-04-23 21:24:15 -07:00
R David Murray
393b7b59a4
#14640 : Fix typos/syntax in pyporting.rst.
...
Patch by Dionysios Kalofonos.
2012-04-23 14:46:39 -04:00
Sandro Tosi
da999d29ab
Issue #14641 : minor fixes to sockets Howto; patch by Dionysios Kalofonos
2012-04-23 19:44:51 +02:00
Raymond Hettinger
016878aea6
merge
2012-04-23 00:22:48 -07:00
Senthil Kumaran
ea17082c25
Update 2.7 docs about legal characters allowed in Cookie name
2012-04-22 10:27:22 +08:00
Ned Deily
9b5952d7cd
Remove webbrowser doc reference to the previously removed internet-config option.
2012-04-18 12:48:09 -07:00
Raymond Hettinger
094c33f047
Minor fixups.
2012-04-18 00:25:32 -04:00
Raymond Hettinger
33c66301ee
Clean-up the SQLite introduction.
2012-04-17 22:48:06 -04:00
Raymond Hettinger
0e15a6e244
Clarify that a new connection needs to be made after the close.
2012-04-17 15:03:20 -04:00
Vinay Sajip
8085f44844
Tweaked format of cookbook example.
2012-04-16 15:45:11 +01:00
Vinay Sajip
4e646aaf93
Added cookbook example for log insertion.
2012-04-16 15:27:55 +01:00
R David Murray
142ab32ecd
#14552 : remove redundant wording in 'test' docs.
...
Original patch by Tshepang Lekhonkhobe.
2012-04-11 20:38:45 -04:00
Senthil Kumaran
dc0b324a0f
Fix closes Issue14258 - Clarify the re.LOCALE and re.UNICODE flags for \S class
2012-04-11 03:22:58 +08:00
Vinay Sajip
2a1c13bb2d
Updated logging reference and HOWTO.
2012-04-10 19:52:06 +01:00
Senthil Kumaran
3661473ae0
minor .rst fix
2012-04-10 19:50:08 +08:00
Sandro Tosi
ceeb47d0c3
Issue #14502 : release() and unlocked lock generates a ThreadError
2012-04-05 22:51:00 +02:00
Georg Brandl
b45c5e2d0e
Closes #14489 : correct link target.
2012-04-05 09:04:40 +02:00
R David Murray
5fc56eb1ca
#14481 : fix formatting of example in subprocess docs.
2012-04-03 08:46:05 -04:00
Sandro Tosi
d987c0221c
fix typo; thanks to Robert Bardos from docs@
2012-04-01 01:49:46 +02:00
Sandro Tosi
6ca845c66a
use unittest.skip; thanks to Chang Min Jeon from docs@
2012-03-31 18:34:42 +02:00
Sandro Tosi
04cd09552a
add 'safari' to webbrowser browsers table; thanks to Jonathan Eunice from docs@
2012-03-31 17:22:47 +02:00
R David Murray
5080cad646
#10423 : clarify options vs args in argparse discussion of optparse
...
Patch by Sandro Tosi.
2012-03-30 18:09:07 -04:00
R David Murray
de294ec02e
#14416 : add missing LOG_SYSLOG facility to syslog docs.
2012-03-29 06:47:59 -04:00
Sandro Tosi
48a88953cc
Issue #14410 : fix typo in argparse doc; patch by Tshepang Lekhonkhobe
2012-03-26 19:35:52 +02:00
Vinay Sajip
49d5fbab87
Minor documentation tweak.
2012-03-26 17:06:44 +01:00
Georg Brandl
99c1f594b3
Closes #14401 : fix typos in curses howto.
2012-03-25 08:43:22 +02:00
Martin v. Löwis
fcf37c1896
Issue #14400 : Fix typo.
2012-03-24 17:38:29 +01:00
Georg Brandl
94a105705f
Closes #14250 : regex.flags has not only explicit flags but also those from the pattern
2012-03-17 17:31:32 +01:00
Georg Brandl
5a607b06d6
Closes #14343 : avoid shadowing builtin input() in example code.
2012-03-17 17:26:27 +01:00
Georg Brandl
ce54617260
Closes #14342 : remove out-of-date section about avoiding recursion errors.
2012-03-17 17:25:47 +01:00
Georg Brandl
f354f8e369
Closes #14306 : clarify expensiveness of try-except and update code snippet
2012-03-17 16:58:05 +01:00
Senthil Kumaran
e3d73544ad
explain json.dumps for non-string keys in dicts. closes issue6566. Patch contributed Kirubakaran Athmanathan
2012-03-17 00:37:38 -07:00
R David Murray
bee24df3a7
#11780 : s/throw/raise/
2012-03-16 22:11:22 -04:00
R David Murray
0cc4e53d1d
#11780 : document that email.encoders throw TypeError on multipart messages.
2012-03-16 22:06:08 -04:00
R David Murray
32a3b147b2
#12758 : removing confusing mention of UTC from time.time description
...
Patch by Dylan Sarber.
2012-03-15 03:05:01 -04:00
Georg Brandl
f590e0458e
Closes #14289 : put a link to the CHM download page on the docs download page.
2012-03-14 08:18:47 +01:00
Senthil Kumaran
c768d4caa8
closes issue14257 - Grammatical fix
2012-03-12 10:05:04 -07:00
Senthil Kumaran
814d316888
closes issue14257 minor error in glossary wording regarding __hash__
2012-03-11 21:04:05 -07:00
Senthil Kumaran
15b6f3f825
Fix closes issue14258 - added clarification to \W and \S flags
2012-03-11 20:37:39 -07:00
Mark Dickinson
5081957642
Closes #9574 : Note that complex constructor doesn't allow whitespace around central operator.
2012-03-10 16:09:35 +00:00
Barry Warsaw
74f4bd53e0
Bump some more copyright years (as per PEP 101), since this is the first
...
release of 2.6 for 2012.
2012-02-23 10:59:38 -05: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
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
Jason R. Coombs
d6a80ee2c7
Use PEP-8 style in logging example
2012-03-07 10:24:04 -05:00
Éric Araujo
d2e19b5173
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:44:49 +01:00
Éric Araujo
76c6aa860c
Use source reST role instead of file where it makes sense.
...
source generates a nifty link to the Mercurial web viewer.
2012-03-05 16:43:41 +01:00
Éric Araujo
47546e6e3d
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 16:30:46 +01:00
Georg Brandl
21ccb7318d
Fix link to global module index.
2012-03-03 21:25:42 +01:00
Eli Bendersky
2b65408dec
Issue #11379 : add a note in xml.dom.minidom suggesting to use etree in some cases
2012-03-02 07:45:55 +02:00
Petri Lehtinen
a15a8d2a0c
sqlite3: Port relevant documentation changes from 3.2
...
Initial patch by Johannes Vogel. Issue #13491 .
2012-03-01 21:48:30 +02:00
Ezio Melotti
d9de93eb67
#14155 : remove duplication about search vs match in re doc.
2012-02-29 13:37:07 +02:00
Ezio Melotti
38ae5b2392
#10713 : Improve documentation for \b and \B and add a few tests. Initial patch and tests by Martin Pool.
2012-02-29 11:40:00 +02:00
Larry Hastings
0555cde98d
Issue #13086 : Update howto/cporting.rst to discuss "Python 3" instead of "3.0".
2012-02-28 15:17:23 -08:00
Éric Araujo
92904d3a4a
Branch merge
2012-02-26 03:48:36 +01:00
Éric Araujo
6d37c4e388
Add versionadded for sys.flags.hash_randomization variable
2012-02-26 02:03:39 +01:00
Éric Araujo
060b812a4b
Fix markup errors
2012-02-26 02:00:35 +01:00
Éric Araujo
a358bc3ca2
State explicitely that PYTHONDONTWRITEBYTECODE is equivalent to -B
2012-02-26 01:38:26 +01:00
Éric Araujo
a318a3b2fb
Avoid relying on the default reST role in logging library doc
2012-02-26 01:36:31 +01:00
Éric Araujo
c446ce78b8
Document that shutil.make_archive does not typecheck its logger argument
2012-02-26 01:33:49 +01:00
Éric Araujo
d4e714c746
Fix typo ( #13467 )
2012-02-26 01:29:09 +01:00
Éric Araujo
c8e29dba91
Mark up constants in socket doc as such
2012-02-26 01:25:11 +01:00
Éric Araujo
576c6d7ee1
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. When I get to replace the XXX notes with the real info
for packaging, I’ll backport it.
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-02-26 01:21:31 +01:00
É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
Benjamin Peterson
aee9dfba4a
merge 2.6 with hash randomization fix
2012-02-20 21:44:56 -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
Nick Coghlan
63c54e819e
Issue #13237 : fix typo
2011-10-26 21:34:26 +10:00
Nick Coghlan
65ad31a8f8
Issue #13237 : remove some details that only apply to the 3.x version of this module and cross reference the relocated warning about the dangers of invoking the shell with untrusted input
2011-10-26 21:15:53 +10:00
Nick Coghlan
2ed203af87
Issue #13237 : further updates to subprocess documentation
2011-10-26 21:05:56 +10:00
Ezio Melotti
59b13f4de9
Refactor a bit the codecs doc.
2011-10-25 10:46:22 +03:00
Benjamin Peterson
22dabb6ffa
merge heads
2011-10-24 08:51:46 -04:00
Benjamin Peterson
414ffa86b5
note callable is back in 3.2
2011-10-24 08:51:15 -04:00
Nick Coghlan
8671157863
Issue #13237 : Rearrange subprocess module documentation to emphasise the convenience functions and commonly needed arguments
2011-10-24 22:19:40 +10:00
Florent Xicluna
df10d7cb97
Issue #13141 : Demonstrate recommended style for SocketServer examples.
2011-10-23 23:07:22 +02:00
Petri Lehtinen
c8065e46fe
Whoops, PyException_GetTraceback() is not documented on 2.7
2011-10-23 21:52:10 +03:00
Petri Lehtinen
19465ddc1c
Add the green "New reference" note to the doc of PyException_GetTraceback()
2011-10-23 21:34:57 +03:00
Éric Araujo
b21f51a9d0
Note that the #1548891 fix indirectly fixes shlex ( #6988 , #1170 )
2011-10-23 04:37:51 +02:00
Antoine Pitrou
5a77fe92bd
Issue #1548891 : The cStringIO.StringIO() constructor now encodes unicode
...
arguments with the system default encoding just like the write() method
does, instead of converting it to a raw buffer.
2011-10-22 21:26:01 +02:00
Ezio Melotti
5e30fa5f56
#13233 : fix typo.
2011-10-20 19:49:29 +03:00
Ezio Melotti
a1958734cb
#13219 : clarify section about character sets in the re documentation.
2011-10-20 19:31:08 +03:00
Senthil Kumaran
ddd40312d5
Fix closes Issue6090 - Raise a ValueError, instead of failing with unrelated
...
exceptions, when a document with timestamp earlier than 1980 is provided to
zipfile. Patch contributed by Petri Lehtinen.
2011-10-20 01:38:35 +08:00
Ezio Melotti
1e87da16ea
Remove duplication.
2011-10-19 10:39:35 +03:00
Ezio Melotti
086f927f25
#12277 : add missing comma.
2011-10-18 13:02:11 +03:00
Éric Araujo
9bcbc62062
Update dead references from py.org/dev/faq to the devguide ( #13176 )
2011-10-14 18:05:56 +02:00
Ezio Melotti
7c4b0475ec
Fix/improve markup in whatsnew/2.7.
2011-10-10 00:25:47 +03:00
Ezio Melotti
c54d97b961
#13138 : add missing versionadded. Patch by Andreas Stührk.
2011-10-09 23:56:51 +03:00
Raymond Hettinger
3e0a3faaa2
Clean-up and improve the priority queue example in the heapq docs.
2011-10-09 17:32:43 +01:00
Larry Hastings
fc45bbaccc
Issue #13053 : Added section on migrating from CObject to Capsule
...
to howto/cporting.rst.
2011-10-09 13:03:44 +01:00
Éric Araujo
eb35f25412
Fix a typo and a broken link (part of #10536 ).
...
Found by Franz Glasner in #2504 .
2011-10-08 02:15:04 +02:00
Antoine Pitrou
5472c1c004
Issue #12823 : remove broken link and replace it with another resource.
2011-10-07 17:03:01 +02:00
Éric Araujo
e954ecb9ba
Branch merge
2011-10-06 13:19:34 +02:00
Senthil Kumaran
41d663f0a5
Issue13073 - Address review comments and add versionchanged information in the docs.
2011-10-05 23:52:49 +08:00
Éric Araujo
2e4a2b6434
Fix markup used in the documentation of sys.prefix and sys.exec_prefix.
...
- Using the file role with {placeholders} is IMO clearer than fake
Python code.
- The fact that sys.version[:3] gives '2.7' is a CPython detail and
should not be advertised (see #9442 ), even if some stdlib modules
currently rely on that detail.
2011-10-05 02:34:28 +02:00
Éric Araujo
656b04ecf6
Move doc of sys.dont_write_bytecode to make all attributes sorted again
2011-10-05 02:25:58 +02:00
Senthil Kumaran
83cc512a01
update 2.7 - Document message_body arg in HTTPConnection.endheaders
2011-10-03 07:37:58 +08:00
Ezio Melotti
f17e405eb7
#13076 : fix links to datetime.time.
2011-10-02 12:22:13 +03:00
Senthil Kumaran
169fa9345d
Doc fix. Mathematically correct sentence.
2011-09-29 07:52:46 +08:00
Victor Stinner
63c22fac72
Issue #7732 : Fix a crash on importing a module if a directory has the same name
...
than a Python module (e.g. "__init__.py"): don't close the file twice.
PyFile_FromFile() does also close the file if PyString_FromString() failed. It
did already close the file on fill_file_fields() error (e.g. if the file is a
directory).
2011-09-23 19:37:03 +02:00
Georg Brandl
607cc361bb
Fix bug in heapq priority queue example.
2011-09-18 07:40:05 +02:00
Georg Brandl
21c69b1043
Add info from the docstring for random.gammavariate() to the docs.
2011-09-17 20:36:28 +02:00
Éric Araujo
79c9d4faa7
Port a few markup edits from 3.x
2011-09-09 19:20:27 +02:00
Vinay Sajip
fa4736ef2f
Closes #12906 : Fixed bug in YAML configuration.
2011-09-06 14:06:24 +01:00
Victor Stinner
d99ff29cf9
Update sys.platform doc for #12326 .
...
Backport from Python 3.2 (e11b4c945f7e).
2011-09-05 22:33:55 +02:00
Senthil Kumaran
9541f8eb2b
merge from 3.2. Fix closes Issue11155 - Correct the multiprocessing.Queue.put's arg (replace 'item' with 'obj') in the docs. Patch by Westley Martínez.
2011-09-06 00:23:10 +08:00
Sandro Tosi
cbce2c01a0
Give credit to Adam
2011-09-02 21:23:55 +02:00
Sandro Tosi
a95d19efa6
#12781 : Mention SO_REUSEADDR flag near socket examples
2011-09-02 20:04:20 +02:00
Éric Araujo
b71c15d407
Branch merge
2011-09-02 17:33:10 +02:00
Éric Araujo
cd90f79125
Document that format string don’t support arbitrary dictonary keys.
...
Text adapted from the PEP. Addition requested by Terry J. Reedy on
2011-02-23 on python-dev.
2011-09-01 19:57:01 +02:00
Éric Araujo
2c378ae364
Document that True/False/None don’t use :keyword: in doc
2011-09-01 19:56:04 +02:00
Éric Araujo
7ce05e07c0
Fix some markup and one typo
2011-09-01 19:54:05 +02:00
Éric Araujo
a7cbe28bcc
Avoid using the default reST role. Makes Doc/tools/rstlint.py happy.
2011-09-01 19:49:31 +02:00
Ezio Melotti
4f14a1ff52
From RFC 3629 5- and 6-bytes UTF-8 sequences are invalid, so remove them from the doc.
2011-09-01 08:19:01 +03:00
Sandro Tosi
9bfc16a99e
added versionadd information for pkgutil.get_data(); thanks to Kyle Monson from docs@
2011-08-30 19:40:28 +02:00
Éric Araujo
ecbb7a9423
Add suspicious entries for the Python Porting HOWTO recently added
2011-08-30 01:39:25 +02:00
Éric Araujo
0f697b300c
Remove outdated pointer to optparse ( fixes #11360 ).
...
The doc already points to argparse.
2011-08-26 16:38:40 +02:00
Éric Araujo
1bd3b9cea0
Branch merge
2011-08-26 16:32:36 +02:00
Éric Araujo
cf13c866b1
Document the "optional" argument of distutils’ Extension class
2011-08-26 00:45:18 +02:00
Éric Araujo
5c2f1f6bfd
Fix type information in distutils API reference ( #9302 ).
...
Initial patch by Yue Shuaijie.
2011-08-26 02:08:20 +02:00
Georg Brandl
eacada8656
Close #12838 : fix range() call.
2011-08-25 11:52:26 +02:00
Antoine Pitrou
b384356b9b
Issue #12213 : make it clear that BufferedRWPair shouldn't be called with the
...
same object as reader and writer, and deemphasize it in document order.
2011-08-20 19:51:31 +02:00
Sandro Tosi
9b68092d1d
#12787 : link original MultiCall proposal to webarchive and in a footnote
2011-08-20 17:05:15 +02:00
Sandro Tosi
a7eb3c802e
fix description of \r; thanks to Thomas Waldmann from docs@
2011-08-19 22:54:33 +02:00
Sandro Tosi
da5a9622f1
merge heads
2011-08-19 18:43:43 +02:00
Sandro Tosi
657a7fcb95
mention RFC1123 as origin of 4-year digit; thanks to John Haxby from docs@
2011-08-19 18:39:35 +02:00
Éric Araujo
410024a8fc
Branch merge
2011-08-19 14:24:38 +02:00
Éric Araujo
0dcf59a7bd
Fix typo in command name
2011-08-19 09:30:26 +02:00
Éric Araujo
a2596a4d67
Remove obsolete term + indicate how to find the program ( #1626300 ).
...
Suggested by Terry J. Reedy.
2011-08-19 09:29:56 +02:00
Éric Araujo
e0054c51c7
Link isinstance/issubclass to the ABC glossary entry ( #12256 )
2011-08-19 09:15:47 +02:00
Éric Araujo
f06568cbd8
Fix a typo and remove some unneeded markup
2011-08-19 09:00:56 +02:00
Éric Araujo
e68d4504fd
Add documentation for PEP 370 features in distutils ( #10745 ).
...
Apart from adding a section to describe the user scheme, this changeset
also does some much needed cleanup:
- fixed inverted reST targets
- fixed some paths
- avoided duplicating the same options listing five or six times
- added missing entries for C headers locations
- added documentation for --install-lib
- fixed a few misuses of the option role (see #9312 ), but not all (not
worth the time, but will do it in packaging docs)
- fixed some markup
The paths fixes were done with an eye on the source code in the install
command, so they really describe what’s actually done. The situation on
Mac OS X is rather messy: the fix for #8084 touched site and sysconfig,
but distutils does not use these files anymore since the Great Revert.
I suspect we have a mismatched stdlib at the moment, and the fix is not
even clear (see discussion on #8084 ).
2011-08-19 08:34:52 +02:00
Éric Araujo
afd2fe2aea
Improve documentation for PEP 370 support in site module ( #8617 ).
...
site.USER_BASE and site.USER_SITE are now fully documented. PEP 370 is
outdated with respects to the Mac framework situation, but the code in
sysconfig and the example in the 3.2 What’s New document helped me find
the right values to document for Mac OS X.
The command-line interface of the site module is also described in the
module docs.
The purpose of the usercustomize module is explained in the site docs,
with a gentle introduction in the tutorial (right after the section that
talks about PYTHONSTARTUP; a comment mentions it should be moved from
the tutorial to another file, but that will be another bug).
Various markup and wording improvements were made along the way in the
site module docs. Duplicate and incomplete declarations of environment
variables have also been removed (the original bug report was actually
about these entries :). The site module docs are still a bit messy;
I’ll see about improving them for #11553 .
All these sections are copiously interlinked and findable from the doc
indexes.
2011-08-19 08:20:01 +02:00
Eli Bendersky
7ceef09b74
Issue #12672 : remove confusing part of sentence in documentation
2011-08-19 06:33:39 +03:00
Éric Araujo
99c4c340e6
Add missing documentation for logger argument of shutil.make_archive
2011-08-19 02:51:17 +02:00
Éric Araujo
bd858b75ce
Turn last automatic footnote in this file into a manually-numbered one
2011-08-19 02:28:40 +02:00
Éric Araujo
cdb86f17bf
Branch merge
2011-08-19 02:26:44 +02:00
Éric Araujo
29a0b57e4e
Backport source links from 3.x.
...
Existing links have been updated to use the new reST role. In some
files, I have also made cosmetic changes to the header.
2011-08-19 02:14:03 +02:00
Éric Araujo
d478a46d56
Use standard heading for ast module docs
2011-08-19 02:01:14 +02:00
Éric Araujo
67719bde07
Synchronize argparse docs with 3.x versions
2011-08-19 02:00:07 +02:00
Éric Araujo
d9aeb60465
Remove unneeded reST target
2011-08-19 01:47:48 +02:00
Éric Araujo
a8f66dd52c
Synchronize glossary with py3k.
...
This update includes new entries that apply to 2.7 too, mention of class
decorators, mention of nonlocal, notes about bytecode, markup fixes and
some rewrappings. Future backports of changes should be slightly
easier.
2011-08-19 01:27:00 +02:00
Éric Araujo
52a5a03498
Add Python porting howto from 3.x.
...
No change was necessary to make the file build, contrary to cporting.rst
that uses markup like :c:func: that needs to be changed to :cfunc: in
2.7. Future backports should be straightforward.
2011-08-19 01:22:42 +02:00
Éric Araujo
f595a76d3d
Backport source role for linking to files in the cpython repo.
...
Georg added this role in our 3.2 doc tools and gave the greenlight for a
backport on python-dev.
This code is a simplified version of the 3.2 code; the version of Sphinx
used with Python 2.7 doesn’t have the function used to parse markup like
:role:`text to be displayed <text to be processed>` (I was persuaded it
was a standard reST construct, but it is actually a Sphinx innovation
that has to be supported explicitly in role code —I’ll be damned). It
is thus not possible to write for example :source:`the NEWS file
<Misc/NEWS>`, but :source:`Misc/NEWS` will work.
2011-08-19 00:12:33 +02:00
Sandro Tosi
02ebf4f78b
grammatical fixes; from Darren Yin on docs@
2011-08-18 15:36:15 +02:00
Sandro Tosi
4047d68a05
#12761 : fix wording of zlib license section
2011-08-16 20:02:15 +02:00
Ezio Melotti
5085e8ac67
#12204 : document that str.upper().isupper() might be False and add a note about cased characters.
2011-08-15 14:24:15 +03:00
Ezio Melotti
ca5e908c6e
#12725 : fix working. Patch by Ben Hayden.
2011-08-14 08:27:36 +03:00
Éric Araujo
569ff91a5a
Avoid title case in flowing text (backport from 3.2)
2011-08-13 02:47:38 +02:00
Sandro Tosi
92be113ba9
let PySequence_Check me a link; thanks to tomo cocoa from docs@
2011-08-13 00:39:29 +02:00
Sandro Tosi
c67975beea
it's 'rather than'; reported by James Bateman on docs@
2011-08-12 19:31:15 +02:00
Sandro Tosi
71a5ea0a9b
English fixup, from Mike MacCana on docs@
2011-08-12 19:11:24 +02:00