Ezio Melotti
090f7be6df
#16760 : use ref:`match-objects` instead of :class:`MatchObject`.
2012-12-25 18:10:49 +02:00
Ezio Melotti
9f929bb7df
#16677 : rename section header and fix markup.
2012-12-25 15:45:15 +02:00
Andrew Svetlov
737fb89dd1
Issue #16714 : use 'raise' exceptions, don't 'throw'.
...
Patch by Serhiy Storchaka.
2012-12-18 21:14:22 +02: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
Brian Curtin
655b0c462f
Fix #14901 . Update the Windows FAQ.
...
Patch by Ashish Nitin Patil.
2012-12-16 23:58:09 -06: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
Éric Araujo
3e4a3dcb23
Ignore .nfs* files in distutils ( #7719 ).
...
These files are created by some NFS clients a file is edited and removed
concurrently (see added link in doc for more info). If such a file is
removed between distutils calls listdir and copy, it will get confused.
Other special files are ignored in sdist (namely VCS directories), but
this has to be filtered out earlier.
2012-12-08 14:21:51 -05:00
Andrew Svetlov
09974b4e9e
Drop double newlines printed in some file iteration examples.
...
Patch by Steven Kryskalla.
2012-12-08 17:59:03 +02: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
Chris Jerdonek
c2a7fd60e1
Improve argument/parameter documentation (issue #15990 ).
...
This commit adds "parameter" to the glossary, improves and consolidates the
"argument" glossary entry, and adds a question to the FAQ on the difference
between arguments and parameters.
2012-11-28 02:29:33 -08: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
777db2d838
Fix label in docs (from issue #13538 ).
2012-11-21 05:32:44 -08: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
Ezio Melotti
52e855084d
Update section about dir() in the tutorial.
2012-11-17 12:50:14 +02:00
Ezio Melotti
89b03b0ec6
Rephrase a sentence in the set and dict comprehensions tutorial page.
2012-11-17 12:06:01 +02:00
Chris Jerdonek
f9e49eaefc
Update the description of which package versions PyPI displays (issue #16400 ).
2012-11-14 12:12:30 -08: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
Chris Jerdonek
4ed4b1c7fe
Improve FAQ link in documentation (for issue #16435 ).
2012-11-09 17:52:30 -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
Andrew Svetlov
0e9a065275
Issue #16435 : Link in tutorial now points to python3 FAQ.
...
Thanks to Yongzhi Pan from docs@
2012-11-08 16:10:49 +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
Ezio Melotti
dedfa9bfae
#4711 : break long words in the docs sidebar to avoid overflow.
2012-11-03 18:25:04 +02:00
Georg Brandl
4552e3f95c
Grammar touchup.
2012-11-02 07:34:37 +01: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
1491cbdf63
Issue #14893 : Add function annotation example to function tutorial.
...
Patch by Zachary Ware.
2012-11-01 21:26:55 +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
Andrew Svetlov
e1fa22a8ae
Issue #16370 : Mention Py_SetProgramName in example for very high level embedding.
2012-10-31 16:03:14 +02:00
Andrew Svetlov
4deb16dd75
Remove already dropped function PySys_GetFile from documentation.
...
Thanks to Daniel Müllner from docs@
2012-10-31 12:02:56 +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
Georg Brandl
6a935d9230
merge heads
2012-10-28 13:37:05 +01:00
Georg Brandl
75f0020d29
Remove confusing "Release" and "Date" markers from whatsnews.
2012-10-28 13:35:56 +01: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
Georg Brandl
fffc25da83
#8040 : fix jQuery incompatibility
2012-10-28 07:59:42 +01:00
Ezio Melotti
e5b1023ae2
#8040 : fix the version.
2012-10-27 23:12:48 +03:00
Ezio Melotti
58864b3cad
#8040 : enable the versionswitcher for the autobuild-dev target.
2012-10-27 22:28:48 +03:00
Ezio Melotti
380ce651e9
#8040 : add a version switcher to the documentation. Patch by Yury Selivanov.
2012-10-27 22:09:16 +03: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
Chris Jerdonek
c131b0760d
Fix formatting of syntax description of function definition.
2012-10-25 17:21:22 -07:00
Ezio Melotti
837cd06d36
#16210 : combine the two type() docs. Patch by Pete Sevander.
2012-10-24 23:06:25 +03:00
Jesus Cea
af38774b5f
Closes #16294 : 8 space indent in tutorial
2012-10-22 13:15:17 +02: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
5bf7f1f6e3
Clarify universal-newline wording in tutorial (issue #16266 ).
2012-10-17 20:17:41 -07:00
Andrew Svetlov
abfc7df149
Issue #9583 : Document startup option/environment interaction.
...
Patch by Todd Rovito.
2012-10-17 17:15:43 +03:00
Andrew Svetlov
e9cf97cf20
Issue #16265 : Fix collapsing of code sample in tutorial.
...
Thanks to Yongzhi Pan from docs@
2012-10-17 16:41:28 +03:00
Chris Jerdonek
4fab8f0e06
Issue #16225 : Add additional note to tutorial about changing sequence while looping.
2012-10-15 19:44:47 -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
Ezio Melotti
35cbf16202
Make doctests pass in the functional howto.
2012-10-12 13:24:19 +03:00
Ezio Melotti
45a101db1d
Improve markup in functional.rst, and fix a couple of errors.
2012-10-12 12:42:51 +03:00
Chris Jerdonek
af94724e00
Fix link to str.format() in docs.
2012-10-11 18:47:54 -07: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
Senthil Kumaran
1ed9847a5a
Fix Issue 15922: make howto/urllib2.rst doctests pass.
...
Patch by Chris Jerdonek. Address Ezio's review comment.
2012-10-09 00:37:09 -07: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
Georg Brandl
4614cc4f7f
Closes #16149 : remove now-false statement about the inability to compare Decimal and float objects.
2012-10-06 13:48:39 +02: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
Andrew Svetlov
8cf1cc498f
Issue #16138 : fix typo.
2012-10-05 13:26:10 +03:00
Andrew Svetlov
f532035551
Close open bracket, thanks to Josh Helzer from docs@
2012-10-02 18:39:25 +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
Jesus Cea
33b5769db5
Closes #15953 : Incorrect some fields declaration in the PyTypeObject documentation
2012-09-28 16:34:45 +02:00
Chris Jerdonek
fd448daf77
Close issue #16073 : fix map() example in list comprehension documentation.
...
Thanks for the e-mail report to docs@.
2012-09-28 07:07:12 -07: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
Chris Jerdonek
df12f2bbb6
Issue #16015 : Make welcome message more realistic in tutorial example.
2012-09-25 04:20:29 -07:00
Chris Jerdonek
9bb56a66c5
Issue #16015 : Fix NameError doctest example in tutorial introduction.
2012-09-24 19:28:59 -07:00
Mark Dickinson
05ee5817a1
Issue #14167 : restore statement about breaks in finally clauses.
2012-09-24 20:16:38 +01:00
Ezio Melotti
8618fb6a65
#16019 , #16020 : fix syntax highlight.
2012-09-24 17:30:39 +03:00
Ezio Melotti
c926c59d80
#16017 : capitalize URLs.
2012-09-24 17:07:39 +03:00
Ezio Melotti
4f24af065d
#16014 : fix broken link.
2012-09-24 16:56:59 +03:00
Ezio Melotti
20b8d992b0
#15949 , #15899 : use \ufffd instead of ?.
2012-09-23 15:55:14 +03:00
Ezio Melotti
b1d0e5b11e
#15949 , 15899: avoid using non-latin1 chars in the doc (they break `make all-pdf`).
2012-09-22 11:23:06 +03: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
13bec9b315
#15920 : fix doctests in Doc/howto/regex.rst. Patch by Chris Jerdonek.
2012-09-17 05:29:47 +03: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
Ezio Melotti
56f37aa965
#15437 , #15439 : merge Doc/ACKS.txt with Misc/ACKS and modify Doc/about.rst accordingly.
2012-09-14 01:24:44 +03:00
R David Murray
d8bbde35fe
#14617 : clarify discussion of interrelationship of __eq__ and __hash__.
2012-09-11 13:01:43 -04:00
Senthil Kumaran
2fd8bdbc9d
Fix issue #15899 : Make the unicode.rst doctests pass. Patch by Chris Jerdonek.
2012-09-11 03:17:52 -07: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
Alexander Belopolsky
7330da4297
Issue #15881 : Added NEWS entry and proper credit.
2012-09-09 14:11:45 -04:00
Alexander Belopolsky
59fb38b582
Issue #15881 : Fixed atexit hook in multiprocessing.
2012-09-09 13:16:15 -04: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
R David Murray
f6bd1b0e0d
#15742 : clarify sqlite parameter substitution example.
...
Suggestion and patch by Mike Hoy.
2012-08-20 14:14:18 -04:00
R David Murray
e56bf97ef4
#13579 : teach string.Formatter about 'a'.
...
Patch by Francisco Martín Brugué.
2012-08-19 17:26:34 -04:00
Eli Bendersky
31a11902b3
tutorial typo fix
2012-08-18 09:50:09 +03:00
R David Murray
75fd22519f
#15636 : add versionadded for decodebytes
2012-08-17 20:55:21 -04:00
R David Murray
2c1d1d6310
#15355 : Mention already-executing Exception in generator docs.
...
Patch by Chris Jerdonek.
2012-08-17 20:48:59 -04:00
R David Murray
433ef3b5c3
#15694 : reflow paragraph.
2012-08-17 20:39:21 -04:00
R David Murray
9f0c9401d3
#15694 : Link discussion of file objects to glossary entry.
...
This is analogous to the link for `flie objects` in the description of
'open' that exists in the 2.7 docs, and adds a similar link to the
io docs.
Patch by Chris Jerdonek.
2012-08-17 20:33:54 -04:00
Terry Jan Reedy
f6190c1463
Issue 15660: Clarify 0 prefix for width field in str.format doc.
2012-08-17 15:40:46 -04:00
Richard Oudkerk
d9c026fd77
Issue #15412 : Remove erroneous note about weakrefs
2012-08-17 15:02:47 +01:00