Sandro Tosi
32587fbb89
grammatical fix; thanks to Alex Rudnick from docs@
2013-01-11 10:49:00 +01:00
Ezio Melotti
405079213b
#16154 : fix some doctests in Doc/library. Patch by Ravi Sinha.
2013-01-11 09:09:07 +02:00
R David Murray
3f7beb99dd
#13934 : document sqlite version strings, use correct one in test.
2013-01-10 20:18:21 -05:00
Vinay Sajip
21b30827bc
Issue #16884 : Updated docs to use 'note' directives in a couple of places missed earlier.
2013-01-08 11:25:42 +00:00
Vinay Sajip
e50f4d2220
Issue #16884 : updated logging documentation to include lastResort and use 'note' directives where appropriate.
2013-01-07 14:16:52 +00:00
R David Murray
a4e700c040
#16877 : Add mention that shell-style path expansions are not automatic.
2013-01-06 16:13:10 -05:00
Eli Bendersky
78f3ce577f
Fix method name in documentation (__setstate__ --> __getstate__)
2013-01-02 05:53:59 -08:00
Łukasz Langa
3a8479a583
Fixes `parser.clean()` reported in issue #16820 .
2012-12-31 03:38:39 +01:00
Ezio Melotti
52336f0b50
#16796 : fix typo. Patch by Michael Schurter.
2012-12-28 01:59:24 +02:00
Serhiy Storchaka
c8bd74ddfd
Issue #16682 : Replace "Python string" to "bytes object" in audioop documentation.
2012-12-27 20:43:36 +02:00
Jesus Cea
c73f863a8d
Closes #16789 : :meth:`quit` links to constants instead of own module
2012-12-26 16:47:03 +01:00
Kristján Valur Jónsson
36852b7844
Issue #14574 : Ignore socket errors raised when flushing a connection on close.
2012-12-25 22:46:32 +00:00
Andrew Svetlov
4001e96179
Issue #16711 : Fix required method names for collections.Iterator
...
Thanks to Inada Naoki
2012-12-18 15:48:10 +02:00
Andrew Svetlov
f635172c72
Update example: Counter.subtract returns None, not self
2012-12-17 14:01:16 +02:00
Andrew Svetlov
dfe109e33f
Fix typo
2012-12-17 13:42:04 +02:00
Ezio Melotti
e0035a212b
#16683 : restore alphabetical order in audioop docs. Patch by Serhiy Storchaka.
2012-12-14 20:18:46 +02:00
Ezio Melotti
1e5c9b70b4
#16681 : use "bidirectional class" instead of "bidirectional category".
2012-12-14 20:06:43 +02:00
Senthil Kumaran
2e72831369
Fix issue13211 - Document the reason attribute for urllib.error.HTTPError
2012-12-09 13:51:05 -08:00
Éric Araujo
9bc9ab5f85
Fix a few markup/grammar nits
2012-12-08 18:35:31 -05:00
Ezio Melotti
5a2e2b8ff7
Remove debug output from example.
2012-12-08 12:29:40 +02:00
Andrew Svetlov
ed636a84b9
Specify which I/O ABC methods have implementations in the docs.
2012-12-06 12:20:56 +02:00
Ezio Melotti
d654dedbbb
#16333 : document a way to get rid of trailing whitespace when indent is used.
2012-11-29 00:35:29 +02:00
Andrew Svetlov
74120996f5
Revert duplicate changes in argparse docs.
2012-11-28 19:23:52 +02:00
Andrew Svetlov
e15cb61dde
Issue #11076 : document the way to convert argparse.Namespace to a dict.
...
Initial patch by Virgil Dupras.
2012-11-28 19:17:26 +02:00
Ezio Melotti
28c88f48f9
#16556 : Fix inconsistency between kwds and kwargs. Patch by Taavi Burns.
2012-11-27 19:17:57 +02:00
Chris Jerdonek
0b502ff33b
Add hyperlinks to the docs of some os.path functions (issue #16552 ).
2012-11-25 20:38:01 -08:00
Ezio Melotti
ba4d8ed8f8
#16530 : the "options" arg of os.wait3 is required.
2012-11-23 19:45:52 +02:00
Chris Jerdonek
17fc44c9b3
Improve str() and object.__str__() documentation (issue #13538 ).
2012-11-20 17:31:02 -08:00
Antoine Pitrou
3813c9efb7
The poplib module provides two classes, not one.
2012-11-18 18:37:02 +01:00
Ezio Melotti
a69be2803b
#16053 : document csv.Dialect.strict. Patch by Kushal Das.
2012-11-18 12:55:35 +02:00
Mark Dickinson
ec967246a1
Typo fix.
2012-11-18 10:42:07 +00:00
Mark Dickinson
a3f37408da
Issue #12005 : clarify behaviour of % and // for Decimal objects.
2012-11-18 10:22:05 +00:00
Ezio Melotti
a39a22dc0b
#16420 : document a way to escape metacharacters in glob/fnmatch.
2012-11-17 17:38:11 +02:00
Nadeem Vawda
19e568d254
Issue #15677 : Document that zlib and gzip accept a compression level of 0 to mean 'no compression'.
...
Patch by Brian Brazil.
2012-11-11 14:04:14 +01:00
Chris Jerdonek
df3abec2c9
Link set and frozenset function docs to their class definitions (issue #16436 ).
2012-11-09 18:57:32 -08:00
Ezio Melotti
8b6b176b33
#16440 : fix exception type and clarify example.
2012-11-09 01:08:25 +02:00
Andrew Svetlov
5c90436d64
Issue #16439 : Fix markup in example for stdtypes.
...
Thanks to Yongzhi Pan.
2012-11-08 17:26:53 +02:00
Ezio Melotti
78b18d4b4c
#11481 : update copyreg docs and add example.
2012-11-08 11:04:57 +02:00
Ezio Melotti
402f75d966
#10385 : use the mod role in subprocess docs.
2012-11-08 10:07:10 +02:00
Ezio Melotti
b87f82f8d4
#16304 : clarify match objects docs. Initial patch by Jan Duzinkiewicz.
2012-11-04 06:59:22 +02:00
Chris Jerdonek
11f3f172e7
Link to mapping glossary entry in "Mapping Types - dict" and os.environ docs.
2012-11-03 12:05:55 -07:00
Andrew Svetlov
d183767ca4
Issue #1207589 : Add Cut/Copy/Paste items to IDLE right click Context Menu
...
Patch by Todd Rovito.
2012-11-01 22:41:19 +02:00
Andrew Svetlov
5bb420761f
Reword set docs to use *proper subset/superset* terminology.
2012-11-01 21:47:54 +02:00
Andrew Svetlov
01e1e35f6a
merge heads
2012-10-31 22:05:46 +02:00
Andrew Svetlov
5f91ad3550
Issue #14900 : document added sort keys for profile stats.
2012-10-31 22:03:28 +02:00
Mark Dickinson
6ae568b9df
Issue #16348 : Fix incorrect documentation for Decimal.remainder_near.
2012-10-31 19:44:36 +00:00
R David Murray
a2959cea3f
#16371 : fix up the English a bit more.
2012-10-31 10:50:27 -04:00
Andrew Svetlov
ec42255039
Issue #16371 : fix typo in ctypes documentation.
...
Thanks to George Yoshida.
2012-10-31 16:20:54 +02:00
Brian Curtin
e9aeca7c24
Fix #16197 . Update docstrings and documentation to match winreg code.
...
Patch by Zachary Ware.
2012-10-29 18:16:39 -05:00
Chris Jerdonek
8b7f9f581d
Remove unneeded "Release" and "Date" markers from doc index pages.
2012-10-28 11:08:26 -07:00
Andrew Svetlov
21b102481b
merge heads
2012-10-28 14:12:50 +02:00
Andrew Svetlov
2ec53be2e2
Issue #14570 : Document json sort_keys parameter properly.
...
Patch by Chris Rebert.
2012-10-28 14:10:30 +02:00
Senthil Kumaran
847c33cc3b
Include mention of jenkins as an example framework for doing CI
2012-10-27 11:04:55 -07:00
Ezio Melotti
a20879ffc8
#16206 : Improve examples about dict construction.
2012-10-26 19:14:16 +03:00
Ezio Melotti
837cd06d36
#16210 : combine the two type() docs. Patch by Pete Sevander.
2012-10-24 23:06:25 +03:00
Ned Deily
2778d0d147
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:25:34 -07:00
Chris Jerdonek
f341317185
Issue #16206 : 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:22:33 -07:00
Ezio Melotti
7fa822275b
Fix links to the __next__ method.
2012-10-12 13:42:08 +03:00
Chris Jerdonek
463974916d
Issue #16199 : Fix typo in 2to3 docs. Thanks to Mark Lawrence for the report.
2012-10-11 15:59:32 -07:00
Chris Jerdonek
cc32a68216
Fix placement of shell=True warning in subprocess.Popen() docs.
2012-10-10 22:52:22 -07:00
Chris Jerdonek
4a4a02bbc8
Issue #16115 : Make further improvements to subprocess.Popen() documentation.
2012-10-10 17:46:18 -07:00
Georg Brandl
a1ff83e556
merge 3.2 heads
2012-10-10 16:49:02 +02:00
Georg Brandl
3a2e101be5
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
Andrew Svetlov
a256841b4b
Issue #16174 : Fix suggested usage of dummy_threading module.
...
Patch by Berker Peksag.
2012-10-09 13:44:16 +03:00
Chris Jerdonek
470ee39883
Issue #16115 : Improve subprocess.Popen() documentation around args, shell, and executable arguments.
2012-10-08 23:06:57 -07:00
Hynek Schlawack
0230b6af78
#13498 : Clarify docs of os.makedirs()'s exist_ok argument.
...
Done with great native-speaker help from R. David Murray.
2012-10-07 18:04:38 +02:00
Chris Jerdonek
83fe2e1c22
Issue #14783 : Improve int() docstring and also str(), range(), and slice().
...
This commit rewrites the docstring for int() to incorporate the documentation
changes made in issue #16036 . It also switches the docstrings for int(),
str(), range(), and slice() to use multi-line signatures.
2012-10-07 14:48:36 -07:00
R David Murray
138a314d1a
#9957 : document that SpooledTemporaryFile.truncate does not take size arg
2012-10-06 18:26:56 -04:00
Andrew Svetlov
afbf90c993
Issue #16025 : Minor corrections to the zipfile documentation.
...
Patch by Serhiy Storchaka.
2012-10-06 18:02:05 +03:00
Ezio Melotti
cbd449b416
The file obj passed to ftp.storbinary/storlines must be opened in binary mode.
2012-10-05 14:09:59 +03:00
Ezio Melotti
d0fe3e5abb
#15979 : improve timeit documentation.
2012-10-02 05:35:39 +03:00
R David Murray
6db2335f77
Fix sqlite3 class markup.
2012-09-30 20:44:43 -04:00
Chris Jerdonek
ec3ea94251
Issue #15533 : Clarify docs and add tests for subprocess.Popen()'s cwd argument.
2012-09-30 00:10:28 -07:00
R David Murray
1a1883d566
#16085 : Don't promote shadowing builtins in the configparser example.
2012-09-29 14:40:23 -04:00
R David Murray
5320250485
#16071 : fix more email.message links in mailbox docs.
2012-09-28 15:19:16 -04:00
R David Murray
c5fe4073af
#16071 : fix links to email.message.Message in mailbox docs.
2012-09-28 15:09:31 -04:00
Chris Jerdonek
57491e0703
Issue #16036 : Improve documentation of built-in int()'s signature and arguments.
2012-09-28 00:10:44 -07:00
Barry Warsaw
1dedd0a4a4
- Issue #15935 : Clarification of argparse docs, re: add_argument() type and
...
default arguments. Patch contributed by Chris Jerdonek.
2012-09-25 10:37:58 -04:00
Mark Dickinson
4e12ad19c9
Issue 15985: fix round argument names in documentation. Thanks Chris Jerdonek.
2012-09-20 20:51:14 +01:00
Ezio Melotti
694f2331c6
Fix a few quotes/backslashes.
2012-09-20 09:47:03 +03:00
Ezio Melotti
8bbcb584dd
Fix markup in smtpd.rst.
2012-09-20 09:06:51 +03:00
Ezio Melotti
a3ccb237c7
Fix rst markup in timeit docs.
2012-09-20 06:13:38 +03:00
Ezio Melotti
26e5878d6f
#11643 : fix rst markup error in site.rst.
2012-09-17 08:59:36 +02:00
Ezio Melotti
186d5238ea
#15789 : mention shell-like parts of the stdlib in the subprocess docs. Patch by Chris Rebert.
2012-09-15 08:34:08 +03:00
Ezio Melotti
e34f8a943b
#15932 : use with statement in csv doc examples. Patch by Dario Bertini.
2012-09-15 05:51:45 +03:00
Ezio Melotti
e0add76468
#15831 : document multiple signatures on different lines. Patch by Chris Jerdonek.
2012-09-14 06:32:35 +03:00
R David Murray
5abd76a75d
#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:15:58 -04:00
Richard Oudkerk
b517596721
Issue #15901 : Change example to use byte string instead of string
2012-09-10 13:00:33 +01:00
R David Murray
14d66a98ed
#5088 : document behavior of optparse defaults with 'append' action.
2012-09-08 16:45:35 -04:00
Ezio Melotti
8bdcdc235e
Merge heads.
2012-09-08 20:52:19 +03:00
Ezio Melotti
e927e25637
#15865 : add "*" in the signature to document keyword-only args in the docs. Patch by Chris Jerdonek.
2012-09-08 20:46:01 +03:00
R David Murray
1585b70813
#15510 : clarify textwrap's handling of whitespace, and add confirming tests.
...
Patch by Chris Jerdonek.
2012-09-08 13:13:25 -04:00
Andrew Svetlov
ff63e7afcf
Issue #15825 : fix typo in OrderedDict docs.
...
Patch by Mike Hoy.
2012-08-31 13:54:54 +03:00
Ezio Melotti
49ccd514d2
Add missing comma.
2012-08-29 17:50:42 +03:00
Petri Lehtinen
72b1426cfb
#11964 : Document a change in v3.2 to the json indent parameter
2012-08-28 07:08:44 +03:00
Petri Lehtinen
72c6eefcc6
Fix a JSON doc typo
2012-08-27 20:27:30 +03:00
Ezio Melotti
aa935dfe9c
#15788 : fix broken links in subprocess doc. Patch by Chris Rebert.
2012-08-27 10:00:05 +03:00
Antoine Pitrou
15251a99bb
Add glossary references
2012-08-24 19:49:08 +02:00
Antoine Pitrou
331624b67d
Issue #14674 : Add a discussion of the json module's standard compliance.
...
Patch by Chris Rebert.
2012-08-24 19:37:23 +02:00
Antoine Pitrou
9439f04b9a
Issue #14954 : Clarify the interaction of weak references and garbage collection.
...
Patch by Ethan Furman.
2012-08-21 00:07:07 +02:00