Sandro Tosi
2534f9aa39
grammatical fix; thanks to Alex Rudnick from docs@
2013-01-11 10:48:34 +01:00
Ezio Melotti
57dfb227a3
#16154 : fix some doctests in Doc/library. Patch by Ravi Sinha.
2013-01-11 08:53:10 +02:00
R David Murray
bcd9971b05
#13934 : document sqlite version strings.
2013-01-10 20:22:57 -05:00
Ned Deily
ec8f8f7959
Issue #15782 : Prevent compile errors of OS X Carbon modules _Fm, _Qd, and
...
_Qdoffs when compiling with an SDK of 10.7 or later. The OS X APIs they
wrap have long been deprecated and have now been removed with 10.7.
These modules were already empty for 64-bit builds and have been removed
in Python 3. (Original patch by Ronald Oussoren.)
2013-01-09 22:04:35 -08:00
Vinay Sajip
3a5fc4bcb8
Issue #16884 : Updated docs to use 'note' directives.
2013-01-08 11:18:42 +00:00
R David Murray
b847c7fcfe
#16877 : Add mention that shell-style path expansions are not automatic.
2013-01-06 16:14:57 -05:00
Giampaolo Rodola'
049a378cd7
issue 10527: fix missing import
2013-01-03 02:53:28 +01:00
Eli Bendersky
f29abd3254
Fix method name in documentation (__setstate__ --> __getstate__)
2013-01-02 06:02:23 -08:00
Raymond Hettinger
c195b4e88c
Make the from_iterable() recipe more usable.
...
The code isn't exactly equivalent because a classmethod would
only make sense inside a chain class, and it would need "cls"
as a first argument, and it would need to return an instance
of "chain" rather than a generator.
The updated example drops the @classmethod decorator so that
it can be used standalone: list(from_iterable(['abc', 'def']))
This should be communicate what from_iterable does.
2012-12-28 00:03:30 -08:00
Ezio Melotti
82ee30384c
#16796 : fix typo. Patch by Michael Schurter.
2012-12-28 01:59:24 +02:00
Jesus Cea
4947049b40
Closes #16789 : :meth:`quit` links to constants instead of own module
2012-12-26 16:46:04 +01:00
Kristján Valur Jónsson
b0d1c37d73
Issue #14574 : Ignore socket errors raised when flushing a connection on close.
2012-12-25 22:46:32 +00:00
Ezio Melotti
513e9b4f61
#16666 : document default values for socket.getaddrinfo in the text to clarify that it doesn't accept keyword args.
2012-12-25 14:45:55 +02:00
Georg Brandl
9a772e5e8f
Fix indentation.
2012-12-22 10:43:06 +01:00
Andrew Svetlov
78efadb86f
Update example: Counter.subtract returns None, not self
2012-12-17 14:01:03 +02:00
Ezio Melotti
eea058b014
#16683 : restore alphabetical order in audioop docs. Patch by Serhiy Storchaka.
2012-12-14 20:18:46 +02:00
Ezio Melotti
28d21cab1f
#16681 : use "bidirectional class" instead of "bidirectional category".
2012-12-14 20:06:43 +02:00
Senthil Kumaran
bfb0989ea7
Document the reason attribute of urllib.HTTPError Patch by Berker Peksag
2012-12-09 13:36:40 -08:00
Andrew Svetlov
bd5279ea24
Drop double newlines printed in some file iteration examples.
...
Patch by Steven Kryskalla.
2012-12-08 18:01:27 +02:00
Ezio Melotti
b7bc92530e
Remove debug output from example.
2012-12-08 12:29:40 +02:00
Andrew Svetlov
766849b978
Document that hour in datetime.time ctor is optional parameter.
...
Thanks to Sean Munkel from docs@
2012-12-06 16:32:37 +02:00
Benjamin Peterson
d5f462bbc4
document UnicodeError attributes
2012-12-02 11:33:06 -05:00
Ezio Melotti
63b04486f8
#16589 : fix pprint signatures in the doc (backport of 106ee4eb5970).
2012-12-01 19:36:00 +02:00
Andrew Svetlov
6a5c2e64d9
Issue #16194 : document imp.load_dynamic problems
...
when read several extension modules from the same binary object file.
2012-11-29 19:51:28 +02:00
Ezio Melotti
3a237ebcaa
#16333 : document a way to get rid of trailing whitespace when indent is used.
2012-11-29 00:22:30 +02:00
Ezio Melotti
eff174b8b0
#16556 : Fix inconsistency between kwds and kwargs. Patch by Taavi Burns.
2012-11-27 19:17:57 +02:00
Chris Jerdonek
55b4cfb992
Add hyperlinks to the docs of some os.path functions (issue #16552 ).
2012-11-25 20:35:23 -08:00
Ezio Melotti
56913b7500
#16530 : the "options" arg of os.wait3 is required.
2012-11-23 19:45:52 +02:00
Ezio Melotti
01560de287
#16503 : clarify "apply" docs.
2012-11-18 21:23:44 +02:00
Antoine Pitrou
9fab5ce662
The poplib module provides two classes, not one.
2012-11-18 18:37:02 +01:00
Ezio Melotti
355637be32
#16053 : document csv.Dialect.strict. Patch by Kushal Das.
2012-11-18 12:55:35 +02:00
Mark Dickinson
3c9181b927
Typo fix.
2012-11-18 10:41:29 +00:00
Mark Dickinson
0d18731815
Issue #12005 : clarify behaviour of % and // for Decimal objects.
2012-11-18 10:20:28 +00:00
Ezio Melotti
1df43d33d2
#16420 : document a way to escape metacharacters in glob/fnmatch.
2012-11-17 17:38:11 +02:00
Chris Jerdonek
9e173ebde2
Link to "XRange Type" section in xrange() built-in function documentation.
2012-11-14 02:13:28 -08:00
Nadeem Vawda
04050b80b1
Issue #15677 : Document that zlib and gzip accept a compression level of 0 to mean 'no compression'.
...
Patch by Brian Brazil.
2012-11-11 13:52:10 +01:00
Chris Jerdonek
67f089f860
Backport from 3.2: adjust set and frozenset function docs (issue #16436 ).
2012-11-09 19:12:02 -08:00
Ezio Melotti
090177676a
#16440 : fix exception type and clarify example.
2012-11-09 01:03:44 +02:00
Andrew Svetlov
3eb0e1da80
Issue #16439 : Fix markup in example for stdtypes.
...
Thanks to Yongzhi Pan.
2012-11-08 17:29:02 +02:00
Ezio Melotti
527b1499cc
#11481 : fix markup.
2012-11-08 11:02:58 +02:00
Ezio Melotti
b1c0e3b229
#11481 : update copy_reg docs and add example.
2012-11-08 10:59:03 +02:00
Ezio Melotti
26025d6385
#10385 : use the mod role in subprocess docs.
2012-11-08 10:07:10 +02:00
Ezio Melotti
51c374dede
#16304 : clarify match objects docs. Initial patch by Jan Duzinkiewicz.
2012-11-04 06:46:28 +02:00
Chris Jerdonek
b9829fca71
Backport from 3.2: link to mapping glossary entry in docs.
2012-11-03 12:13:46 -07:00
Andrew Svetlov
5018db76aa
Issue #1207589 : Add Cut/Copy/Paste items to IDLE right click Context Menu
...
Patch by Todd Rovito.
2012-11-01 22:39:14 +02:00
Andrew Svetlov
2c184c6d75
Reword set docs to use *proper subset/superset* terminology.
2012-11-01 21:47:05 +02:00
Andrew Svetlov
8a9b401a7d
Issue #14900 : document added sort keys for profile stats.
2012-10-31 21:54:45 +02:00
Mark Dickinson
89e8f54045
Issue #16348 : Fix incorrect documentation for Decimal.remainder_near.
2012-10-31 19:44:09 +00:00
R David Murray
c454fe4509
#16371 : fix up the English.
2012-10-31 10:53:13 -04:00
Andrew Svetlov
1625d88709
Issue #16341 : convert examples to use except ... as ... syntax.
2012-10-30 21:56:43 +02:00
Chris Jerdonek
64c0b2ca3d
Backport from 3.2: remove "Release" and "Date" markers from index pages.
2012-10-28 11:16:36 -07:00
Andrew Svetlov
41c25ba451
Issue #14570 : Document json sort_keys parameter properly.
...
Patch by Chris Rebert.
2012-10-28 14:58:52 +02:00
Andrew Svetlov
61822667df
Issue #14616 : Document pipes.quote and mention this one in subprocess docs.
...
Patch by Chris Rebert.
2012-10-28 11:48:02 +02:00
Ezio Melotti
e793f44abe
#16332 : use "except OSError as e" in subprocess docs. Patch by Berker Peksag.
2012-10-26 23:10:07 +03:00
Ezio Melotti
8221f86513
#16206 : Improve examples about dict construction.
2012-10-26 19:14:16 +03:00
Ezio Melotti
b8fbff889f
#16210 : combine the two type() docs. Patch by Pete Sevander.
2012-10-24 23:01:30 +03:00
Ned Deily
c859bd2b28
Issue #10405 : Document IDLE context menus in Standard Library document
...
and IDLE Help file. (Thanks to Nick ODell and Todd Rovito for suggestions.)
Update Debug menu options in docs to match current code plus various other
minor IDLE doc and help edits.
2012-10-20 13:23:25 -07:00
Andrew Svetlov
ae1d185750
Issue #15936 : Reformat text for os.random to follow Larry Hastings suggestion
2012-10-16 13:51:26 +03:00
Andrew Svetlov
8a9d370a2b
Issue #15936 : Add link from os.urandom to random.SystemRandom
2012-10-16 13:23:15 +03:00
Chris Jerdonek
def5df6c53
Issue #16206 : Backport dict documentation improvements from 3.2.
...
Improve the documentation of the dict constructor. This change includes
replacing the single-line signature documentation with a more complete
multiple-line signature.
2012-10-13 03:49:30 -07:00
Chris Jerdonek
2aa5afab4e
Issue #16199 : Backport 2to3 typo fix from 3.2.
2012-10-11 16:15:46 -07:00
Chris Jerdonek
1e65159b34
Backport from 3.2: Fix placement of shell=True warning in subprocess.Popen() docs.
2012-10-10 22:58:57 -07:00
Chris Jerdonek
2a6672b100
Issue #16115 : Backport subprocess.Popen() documentation improvements from 3.2.
2012-10-10 17:55:41 -07:00
Chris Jerdonek
cfb01a5ad0
Issue #12947 : Backport doctest documentation change from 3.3.
2012-10-10 08:39:34 -07:00
Georg Brandl
a11c1fcd20
Missed one instance of code-block:: text highlighting to revert.
2012-10-10 16:56:15 +02:00
Georg Brandl
7495456ffc
Issue #12947 : revert earlier workaround and use a monkey-patch to enable showing doctest directives only in the doctest docs.
2012-10-10 16:45:11 +02:00
Chris Jerdonek
d469c400ed
Issue #12947 : Backport doctest documentation improvements from 3.3.
2012-10-10 07:13:56 -07:00
Chris Jerdonek
1906c0c992
Issue #16115 : Backport subprocess.Popen() documentation improvements from 3.2.
2012-10-08 23:18:17 -07:00
Chris Jerdonek
ad4b000179
Issue #14783 : Backport changes from 3.2.
2012-10-07 20:37:54 -07:00
R David Murray
fefd3ac04c
#9957 : document that SpooledTemporaryFile.truncate does not take size arg
2012-10-06 18:26:40 -04:00
Andrew Svetlov
8c4419304d
Issue #16025 : Minor corrections to the zipfile documentation.
...
Patch by Serhiy Storchaka.
2012-10-06 18:01:05 +03:00
Nick Coghlan
7c0a87f211
Issue #12947 : Better workaround for the problem with doctest directives being stripped from code examples that are intended to illustrate those directives
2012-10-03 13:48:17 +05:30
Nick Coghlan
a42709e6bb
Issue #12947 : Add a note to doctest until the example rendering is fixed
2012-10-03 12:18:23 +05:30
Ezio Melotti
31a9e83d7d
#15979 : improve timeit documentation.
2012-10-02 05:34:38 +03:00
Chris Jerdonek
71d74b0c4e
Close #16036 : Backport 3.x documentation improvement.
...
See changeset 6ccb04c4cbae for the corresponding 3.3 change.
2012-09-30 21:07:56 -07:00
R David Murray
95d7cdfd7b
Fix sqlite3 class markup.
2012-09-30 21:04:46 -04:00
Chris Jerdonek
fab57ccd13
Close issue #16077 : fix code example in documentation of reduce() built-in (from docs@).
2012-09-29 11:51:37 -07:00
R David Murray
3e09b14026
#16085 : Don't promote shadowing builtins in the configparser example.
2012-09-29 14:44:16 -04:00
R David Murray
9faaf1b43e
#16071 : fix email.message links in the mailbox docs.
2012-09-28 15:21:32 -04:00
Andrew Svetlov
0c68c5ddb2
Update docs for string.zfill
2012-09-28 16:32:27 +03:00
Andrew Svetlov
9ac20231e0
Update documentation for string.replace. Thanks to docs@
2012-09-28 16:31:06 +03:00
Raymond Hettinger
1b43274d12
Show how to close a connection
2012-09-25 19:57:50 -04:00
Barry Warsaw
0dea936e78
- Issue #15935 : Clarification of argparse docs, re: add_argument() type and
...
default arguments. Patch contributed by Chris Jerdonek.
2012-09-25 10:32:53 -04:00
Mark Dickinson
39e0fb01ef
Issue 15985: fix round argument names in documentation. Thanks Chris Jerdonek.
2012-09-20 20:57:37 +01:00
Ezio Melotti
a8e49638d1
Fix a few quotes/backslashes.
2012-09-20 09:48:07 +03:00
Ezio Melotti
aea83f53ee
Fix rst markup in timeit docs.
2012-09-20 06:02:50 +03:00
Ezio Melotti
b3b32fbd69
#11643 : fix rst markup error in site.rst.
2012-09-17 08:59:36 +02:00
Ezio Melotti
eab4df5830
#15789 : mention shell-like parts of the stdlib in the subprocess docs. Patch by Chris Rebert.
2012-09-15 08:33:12 +03:00
Ezio Melotti
a733d814be
#15932 : use with statement in csv doc examples.
2012-09-15 05:46:24 +03:00
Ezio Melotti
714e64ebd1
#15831 : avoid using 3.x syntax for keyword-only args.
2012-09-15 04:45:57 +03:00
Ezio Melotti
ed3f5900d4
#15831 : document multiple signatures on different lines. Patch by Chris Jerdonek.
2012-09-14 06:48:32 +03:00
R David Murray
8d580539f0
#14649 : clarify DocTestSuite error when there are no docstrings.
...
Also adds tests to verify the documented behavior (which is probably a bug, as
indicated in the added comments).
Patch by Chris Jerdonek.
2012-09-10 10:17:13 -04:00
R David Murray
b9495c78a1
closes #5088 : document behavior of optparse defaults with 'append' action.
2012-09-08 16:47:24 -04:00
R David Murray
1b6e7c47f2
#15510 : clarify textwrap's handling of whitespace, and add confirming tests.
...
Patch by Chris Jerdonek.
2012-09-08 13:42:01 -04:00
Petri Lehtinen
f9e1f1128b
#13769 : Enhance docs for ensure_ascii semantics in JSON decoding functions
2012-09-01 07:29:06 +03:00
Andrew Svetlov
2b326e4c2b
Issue #15825 : fix typo in OrderedDict docs.
...
Patch by Mike Hoy.
2012-08-31 13:53:30 +03:00
Ezio Melotti
6bb9c73b06
Add missing comma.
2012-08-29 17:50:42 +03:00
Vinay Sajip
3d212e6ee5
Closes #15807 : Removed incorrect directive from help.
2012-08-29 14:25:42 +01:00
Hynek Schlawack
7d978902d0
#14880 : Fix kwargs notation in csv.reader, .writer & .register_dialect
...
Patch by Chris Rebert.
2012-08-28 12:33:46 +02:00
Ezio Melotti
8662c84ac8
#15788 : fix broken links in subprocess doc. Patch by Chris Rebert.
2012-08-27 10:00:05 +03:00