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
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
É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
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
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
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
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
0f697b300c
Remove outdated pointer to optparse ( fixes #11360 ).
...
The doc already points to argparse.
2011-08-26 16:38:40 +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
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
É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
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
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
Vinay Sajip
5088b504be
Issue #12718 : Add documentation on using custom importers.
2011-08-11 13:39:52 +01:00
Senthil Kumaran
ea75f4cf3b
Fix closes Issue12722 - link heapq source in the text format in the documentation.
2011-08-10 21:54:56 +08:00
Sandro Tosi
a9c9b2c38c
#12709 : add error_callback argument to map_async documentation
2011-08-08 16:37:44 +02:00
Sandro Tosi
1381a31e39
#12677 : correct turtle orientation in doc
2011-08-07 17:09:15 +02:00
Eli Bendersky
e11af59e2a
Fix grammar
2011-08-06 09:29:12 +03:00
Senthil Kumaran
b8b71725c3
Fix closes Issue12697 - Update the usage syntax of timeit module in the docs.
2011-08-06 13:34:30 +08:00
Senthil Kumaran
c1ee4ef9dc
Fix closes issue12663 - Correcting the ArgumentParser.error description. Patch by Sandro Tosi.
2011-08-03 07:43:52 +08:00
Sandro Tosi
25fb852e55
#12670 : Fix struct code after forward declaration on ctypes doc
2011-08-02 16:16:11 +02:00
Senthil Kumaran
22a7b488e0
Fix closes Issue12183 - Explain the Symlink copy behavior in shutil.copytree. Patch by Petri Lehtinen.
2011-08-02 18:50:44 +08:00
Georg Brandl
93d3a8d67c
Use attribute access instead of index access for namedtuple.
2011-08-01 22:58:53 +02:00
Vinay Sajip
5d09ba46c9
Closes #12667 : Corrected documentation for SMTPHandler secure argument.
2011-08-01 11:28:02 +01:00
Benjamin Peterson
35fd1b9107
be precise
2011-07-30 22:08:09 -05:00
Benjamin Peterson
110b781129
note Ellipsis syntax
2011-07-30 09:59:12 -05:00
Benjamin Peterson
6726af73de
add space
2011-07-30 09:58:59 -05:00
Benjamin Peterson
f444f94ed2
document NotImplemented
2011-07-30 09:57:24 -05:00
Eli Bendersky
dedb502f90
Issue #11699 : fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen
2011-07-30 11:12:45 +03:00
Éric Araujo
43162e22c5
Document that atexit execution order is undefined ( #9788 )
2011-07-29 18:04:24 +02:00
Éric Araujo
f0d44bccb7
Add a link target for argparse.Namespace ( #8982 )
2011-07-29 17:59:17 +02:00
Éric Araujo
345fff3de8
Remove mentions of previous license in profile module ( #12417 followup)
2011-07-28 22:27:28 +02:00
Éric Araujo
d01aebe3d6
Update documentation for shutil.move ( #12043 ) and fix a few typos.
...
Adding Sandro Tosi to Doc/ACKS for this patch and all his work on the
docs mailing list and on the bug tracker.
2011-07-29 12:10:53 +02:00
Éric Araujo
2e1c294d28
Fix “anyways” (following R. David Murray in 5c7520e02d5a)
2011-07-29 11:57:50 +02:00
Éric Araujo
ad84ea11c2
Add links from builtins module docs to built-in functions and constants docs
2011-07-29 11:53:57 +02:00
Éric Araujo
5dd034b84f
Minor doc addition for clarity
2011-05-27 04:42:47 +02:00
Éric Araujo
8fde9506b7
Improve glossary entry for ABCs.
...
- Rename reST target name for collections ABCs to avoid collisions
- Link to glossary entry from numbers module doc (other modules already do it)
2011-07-29 11:34:17 +02:00
Éric Araujo
beb9170cc4
Merge #12417 followup, also removing an extra docstring
2011-07-28 22:32:04 +02:00
Ezio Melotti
8171cf52b6
#12642 : fix args names in open() doc.
2011-07-27 08:48:52 +03:00
Ross Lagerwall
528c4adc0b
Issue #12102 : Document that buffered files must be flushed before being used
...
with mmap. Patch by Steffen Daode Nurpmeso.
2011-07-25 07:23:58 +02:00
Ezio Melotti
b952413499
Fix markup.
2011-07-21 11:38:13 +03:00
Senthil Kumaran
cd57ef1a47
merge from 3.2 - Fix closes issue12524 - update http.client POST example with a working example. - Patch contributed by Bharadwaj
2011-07-20 22:02:27 +08:00
Senthil Kumaran
60bf489e8a
merge from 3.2 - Fix closes issue12577 - clarify shutil.move documentation. Patch suggestion by Catalin Iacob
2011-07-19 08:05:44 +08:00
Antoine Pitrou
711cb58db1
Issue #6476 : Document that os.spawnle and os.spawnve are not thread-safe under Windows.
2011-07-19 01:26:58 +02:00
Senthil Kumaran
1c0ebc0fa5
fix whitespace in rst.
2011-07-18 07:18:40 +08:00
Senthil Kumaran
a2dd57aaf1
merge from 3.2 - Fix closes Issue12478 - HTTPErrorProcess 's methods are http_response and https_response.
2011-07-18 07:16:02 +08:00
Senthil Kumaran
612b2b338b
merge from 3.2 - Fix closes Issue12479 - Add HTTPErrorProcessor class definition - Patch by Sandro Tosi
2011-07-18 06:44:11 +08:00
Senthil Kumaran
4c9721ad40
merge from 3.2 - Issue10403 - datetime module documentation changes based on review.
2011-07-17 19:10:10 +08:00
Senthil Kumaran
a09f13a0bc
merge from 3.2.
2011-07-17 17:31:51 +08:00
Eli Bendersky
877f2e4530
Issue #12574 : correct capitalization of the Queue module. Patch by Rafe Kettler
2011-07-17 05:54:06 +03:00
Raymond Hettinger
cec795d639
It is really a suffix :-)
2011-07-14 14:41:43 +08:00
Ned Deily
0ab67ee79e
Issue #12549 : Correct test_platform to not fail when OS X returns 'x86_64'
...
as the processor type on some Mac systems. Also fix NameError in fallback
_mac_ver_gestalt function. And remove out-of-date URL in docs.
2011-07-13 15:05:31 -07:00
Antoine Pitrou
0504532c39
Mention logging.captureWarnings in the warnings module doc.
2011-07-09 21:29:36 +02:00
Antoine Pitrou
73705902c4
Move sys.subversion at the right place in alphabetical order,
...
and add a note concerning its status.
2011-07-09 16:06:19 +02:00
Antoine Pitrou
ea901ad2c6
Issue #12326 : document the recommended idiom for checking sys.platform on Unix systems.
...
Also, point to the various alternatives.
2011-07-09 15:48:29 +02:00
Victor Stinner
8703be94b1
Issue #12423 : Fix os.abort() documentation
...
The Python signal handler for SIGABRT is not called on os.abort() (only if the
signal is raised manually or sent by another process). Patch by Kamil Kisiel.
2011-07-08 02:14:55 +02:00
Senthil Kumaran
6f18b98782
Fix closes issue10403 - Let's not use members anymore.
2011-07-04 12:50:02 -07:00
Senthil Kumaran
e04d256c2d
reST indentation fix in sqlite3 docs. rst uses 3 space indentation.
2011-07-03 10:12:59 -07:00
Ned Deily
43e1054e38
Issue #8746 : Correct faulty configure checks so that os.chflags() and
...
os.lchflags() are once again built on systems that support these
functions (*BSD and OS X). Also add new stat file flags for OS X
(UF_HIDDEN and UF_COMPRESSED). Also add additional tests for
os.chflags() and os.lchflags(). (Tests by Garrett Cooper)
2011-06-27 23:41:53 -07:00
Ezio Melotti
4601530137
#11363 : add missing functions from curses doc. Patch by Sandro Tosi.
2011-06-26 13:34:56 +03:00
Ezio Melotti
14989cf4d1
#11363 : clean up curses doc.
2011-06-26 13:33:46 +03:00
Senthil Kumaran
7bf5ba0f79
Fix Issue10020 - Doc update to sqlite3 module in 2.7 branch.
2011-06-25 20:48:21 -07:00
Ezio Melotti
196273e1d0
Use correct markup in zipimport.rst. Patch by Sara Magliacane.
2011-06-25 19:40:06 +03:00
Raymond Hettinger
320b91495a
Issue 11889: Clarify docs for enumerate.
2011-06-25 14:57:06 +02:00
Mark Dickinson
653a53fb14
Issue #12228 : Fix exchanged flag descriptions in stat.rst. Thanks Sandro Tosi.
2011-06-25 12:01:06 +02:00
R David Murray
17e2b40aae
#9921 : clarify os.path.join joining algorithm
...
The new wording is based on the comments in the code, which
match the actual behavior.
2011-06-23 21:19:25 -04:00
R David Murray
1d3365106d
#12389 : fix missing space at sentence end.
2011-06-22 20:00:27 -04:00
R David Murray
491eb6a17e
#6771 : fix docs: curses.wrapper is exposed as a function, not a module
...
Patch by July Tikhonov.
2011-06-18 19:31:22 -04:00
Benjamin Peterson
898d43c7af
update link to pycrypto ( closes #12351 )
2011-06-16 18:49:46 -05:00
Vinay Sajip
ad52cb2613
Closes #12206 : documentation update for LogRecord constructor and Formatter.formatTime.
2011-06-13 14:59:36 +01:00
Raymond Hettinger
45b082935d
Fix named tuples to work with vars().
2011-06-02 20:40:35 -07:00
Raymond Hettinger
88fc66179b
Cleanup example
2011-06-01 16:01:21 -07:00
Raymond Hettinger
690d4ae8bf
Multiple clean-ups to the docs for builtin functions.
...
* Use concrete example for dir() and eliminate the distracting doctest directives.
* Add a pure python equivalent for enumerate()
* Modify the enumerate() example to demonstrate the start argument
* Remove incorrect reference the *iterable* in the enumerate() docs.
* Downgrade the comments on input() from a warning to a note.
* Fix the iter() example to use the empty string as the terminating
condition for file.readline(). Also, the old example was broken
because readline() results include a newline, so 'STOP\n' would have
been the correct terminating condition. Even with that fix, the
STOP example was fragile and would have lead to infinite loops with
malformed inputs.
* Do not refer to classmethod as being "more advanced" than staticmethod.
2011-06-01 15:50:34 -07:00
Raymond Hettinger
783a30f38e
Link to suggestions for how to use super().
2011-06-01 14:57:13 -07:00
Barry Warsaw
cf0d8ab818
Replay changeset 70238:03e488b5c009 from fubar branch. Original commit
...
message:
Reconcile with the 2.6svn branch. The 2.6.7 release will be made from
Subversion, but there were differences, so this brings them in sync. These
changes should *not* propagate to any newer versions.
2011-05-23 15:22:56 -04:00
Eli Bendersky
29f6efa844
Issue 12003: fixing error in xrange alternative sample
2011-05-23 06:10:26 +03:00
Raymond Hettinger
691a659ddb
Simplify example
2011-05-21 09:39:57 -07:00
Benjamin Peterson
ce77defd84
this should actually be an IOError
2011-05-20 11:49:06 -05:00
Benjamin Peterson
30e10d8114
add example for not using access
2011-05-20 11:41:13 -05:00
Ezio Melotti
b429c57481
#12093 : fix typo in struct doc. Patch by Sandro Tosi.
2011-05-17 05:17:35 +03:00
Antoine Pitrou
47d1d0dc30
Issue #8498 : In socket.accept(), allow to specify 0 as a backlog value in
...
order to accept exactly one connection. Patch by Daniel Evers.
2011-05-10 19:16:03 +02:00
Victor Stinner
b1241f9619
(Merge 3.1) Issue #12012 : ssl.PROTOCOL_SSLv2 becomes optional
...
OpenSSL is now compiled with OPENSSL_NO_SSL2 defined (without the SSLv2
protocol) on Debian: fix the ssl module on Debian Testing and Debian Sid.
Optimize also ssl.get_protocol_name(): speed does matter!
2011-05-10 01:52:03 +02:00
Ezio Melotti
87b86c84ef
Add a note to the str.find doc to suggest the use of the "in" operator.
2011-05-09 03:54:30 +03:00
Ezio Melotti
001cc954bb
#11985 : document the return value of platform.python_implementation for PyPy.
2011-05-03 20:41:48 +03:00
Victor Stinner
112d48ac17
(Merge 3.1) Issue #11277 : mmap.mmap() calls fcntl(fd, F_FULLFSYNC) on Mac OS X
...
to get around a mmap bug with sparse files. Patch written by Steffen Daode
Nurpmeso.
2011-05-03 14:36:36 +02:00
Éric Araujo
941592aa19
Fix grammar to include both integer types in 2.x
2011-05-02 13:09:36 +02:00
Raymond Hettinger
ec0ecb1afc
Fix spelling.
2011-05-01 18:14:49 -07:00
Benjamin Peterson
17ebbdb73e
note abcs of int and float ( closes #11977 )
2011-05-01 17:38:17 -05:00
R David Murray
dcaacbf1ef
#11901 : post-commit review fixes per Georg Brandl
2011-04-30 16:34:35 -04:00
Brian Curtin
bb23bd69b9
Fix #11961 . Document STARTUPINFO and creation flag options.
2011-04-29 22:23:46 -05:00
Ezio Melotti
6940e61225
#11952 : Fix typo in multiprocessing doc.
2011-04-29 07:10:24 +03:00
Łukasz Langa
9d68ad862a
Merged solution for #11786 from 2.6
2011-04-28 17:40:19 +02:00
Łukasz Langa
22108f1bb0
Closes #11786 : ConfigParser.[Raw]ConfigParser optionxform().
2011-04-28 17:27:59 +02:00
R David Murray
a0895db2e1
#11901 : add description of how bitfields are laid out to hexversion docs
...
Patch by Sijin Joseph.
2011-04-25 16:10:18 -04:00
Ezio Melotti
c69313a7ab
Fix some more markup glitches in argparse doc.
2011-04-22 01:29:13 +03:00
Ezio Melotti
569083adbf
The \ is not supported in Sphinx 0.6.
2011-04-21 23:30:27 +03:00
Ezio Melotti
d281f1439d
#11905 : fix missing full stop in argparse doc. Noticed by Vladimir Rutsky.
2011-04-21 23:09:27 +03:00
Ezio Melotti
310619c80f
#11904 : fix indentation in argparse doc. Noticed by Vladimir Rutsky.
2011-04-21 23:06:48 +03:00
Ezio Melotti
0a43ecc9df
#11902 : Fix typo in argparse doc. Noticed by Vladimir Rutsky.
2011-04-21 22:56:51 +03:00
Ezio Melotti
01b600c2a3
Add the :mod: role where it was missing.
2011-04-21 16:12:17 +03:00
Ezio Melotti
2eab88e834
#11885 : capitalize Python.
2011-04-21 15:26:46 +03:00
Ezio Melotti
b4923786fa
Fix wrong number of functions noticed by Sandro Tosi.
2011-04-19 23:12:37 +03:00
Vinay Sajip
0513275b58
Updated documentation on fileConfig().
2011-04-19 13:47:23 +01:00
Victor Stinner
059061a237
Issue #11768 : signal.set_wakeup_fd() and PySignal_SetWakeupFd() added in 2.6
...
Fix the documentation.
2011-04-18 16:34:31 +02:00
Ezio Melotti
12125823fa
Fix a few hyphens in argparse.rst.
2011-04-16 23:04:51 +03:00
Eli Bendersky
ad72bb1aa8
Issue #11855 : Apply missing formatting for urlretrieve
2011-04-16 15:28:42 +03:00
Raymond Hettinger
df453fbb5f
Add another example to the collections module docs.
2011-04-15 17:55:36 -07:00
Ezio Melotti
6033d26118
#4783 : document that is not possible to use json.dump twice on the same stream.
2011-04-15 07:37:00 +03:00
Eli Bendersky
929e276176
Issue #11827 : remove mention of list2cmdline in the doc of subprocess
2011-04-15 07:35:06 +03:00
Ezio Melotti
7f9d2ead34
#9101 : backport json reference in configparser doc.
2011-04-14 06:53:44 +03:00
R David Murray
a2472d28fd
Transplant: Fix wording and clarify that the IDNA codec operates on full domain names.
...
Before reading the code to check, I wasn't sure if it operated on
full domain names or just individual labels.
2011-04-13 14:20:30 -04:00
R David Murray
ea8b6ef15f
#10019 : Fix regression relative to 2.6: add newlines if indent=0
...
Patch by Amaury Forgeot d'Arc, updated by Sando Tosi.
2011-04-12 21:00:26 -04:00
Vinay Sajip
5dbca9cc3f
Issue #11794 : Reorganised logging documentation.
2011-04-08 11:40:38 +01:00
Vinay Sajip
3c599bdbd1
Issue #11639 : Configuration function documentation referred to logging.XXX rather than logging.config.XXX.
2011-03-29 01:21:48 +01:00
Vinay Sajip
f851fe9fc5
Issue #11639 : Configuration function documentation referred to logging.XXX rather than logging.config.XXX.
2011-03-29 01:15:37 +01:00
Vinay Sajip
af1fee06c9
Issue #11639 : Configuration function documentation referred to logging.XXX rather than logging.config.XXX.
2011-03-29 01:07:50 +01:00
Ezio Melotti
d113512ed5
#10617 : add class directives to collections ABCs.
2011-03-28 13:46:28 +03:00
Steven Bethard
5e0062d25a
Issue #9343 : Document that argparse parent parsers must be configured before their children. (Merge from 3.2.)
2011-03-26 21:50:38 +01:00
Steven Bethard
3f69a059b9
Issue #8982 : Improve the documentation for the argparse Namespace object. (Merge from 3.2.)
2011-03-26 19:59:02 +01:00
Éric Araujo
254d4b851d
Tweaks to sys.flags description table.
...
The options listed in the table are now links to their documentation,
and the table uses compact markup to make it easier to read and edit.
First proposed in #10998 .
2011-03-26 02:09:14 +01:00
Éric Araujo
8bea9a5b13
Use universal construct os.path.expanduser('~') instead of os.environ['HOME']
2011-03-26 01:24:47 +01:00
Raymond Hettinger
7250730afc
Issue #11625 : Fix Typo
2011-03-22 09:06:38 -07:00
Georg Brandl
b6dc81df2b
Fix duplicate word.
2011-03-21 08:55:16 +01:00
Éric Araujo
c75f26511b
Fix typo in class name
2011-03-20 18:34:24 +01:00
Benjamin Peterson
ec5b5cb489
the name of the option is a bit too low-level
2011-03-20 12:24:20 -05:00
Raymond Hettinger
dbc5e1280f
Minor doc clean-up.
...
* Show list of fields option before showing the single string alternative.
* Remove the PS2 prompts so that the examples become cut-and-pastable.
2011-03-19 15:09:00 -07:00
Ezio Melotti
c2077b0d9b
#11565 : Fix several typos. Patch by Piotr Kasprzyk.
2011-03-16 12:34:31 +02:00
R David Murray
ab40e4cb95
Merge #11216 : document all possible set_charset execution paths.
2011-03-15 18:01:04 -04:00
Ross Lagerwall
a3ed3f03d7
Issue #10885 : Fix multiprocessing docs typo
2011-03-14 10:43:36 +02:00
Ezio Melotti
ad797b699d
#11484 : remove paragraph about with_traceback from 2.7 doc.
2011-03-13 22:55:41 +02:00
Eli Bendersky
ec40bab21e
Issue #11426 : use 'with' statements on open files in CSV examples
2011-03-13 08:45:19 +02:00
Benjamin Peterson
4f1a665fae
clarify condition for readline to return EOF ( closes #11312 )
2011-03-12 17:12:54 -06:00
Vinay Sajip
5ddf51f735
Fixes issue #11476 : StreamHandler parameter name change documented.
2011-03-12 22:43:23 +00:00
Ezio Melotti
c3ab30b363
Fix typo.
2011-03-12 22:21:37 +02:00
Benjamin Peterson
3c5edd00a7
trunc -> math.trunc ( closes #11475 )
2011-03-12 11:58:15 -06:00
R David Murray
efd8bab403
#10999 : Add missing documentation for chflags constants to stat module docs
...
Patch by Michal Nowikowski.
2011-03-10 17:57:35 -05:00
Ezio Melotti
3cbb66b0d9
Use simpler assert in basic example.
2011-03-10 23:35:39 +02:00
Ezio Melotti
dd7c593c1f
Backport from 3.x several improvements and fixes for unittest.rst.
2011-03-10 23:00:48 +02:00
Ezio Melotti
9e1ed47e91
#11298 : Improve the unittest discovery explanation.
2011-03-08 17:08:25 +02:00
Georg Brandl
6076c1b40a
#11292 : add missing A_REVERSE to curses attribute table.
2011-03-06 11:08:35 +01:00
Georg Brandl
6dea5f5702
#11294 : add missing ERA_T_FMT to locale docs.
2011-03-06 11:09:51 +01:00
Georg Brandl
3a610a561a
#11373 : fix spelling.
2011-03-06 10:57:52 +01:00
Georg Brandl
21b832e8c1
#11392 : you can trust the computer, but you have to know what it does.
2011-03-06 10:53:55 +01:00
Benjamin Peterson
17e25d8c65
Merged revisions 88668 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r88668 | benjamin.peterson | 2011-02-27 09:06:44 -0600 (Sun, 27 Feb 2011) | 1 line
make this a link #11345
........
2011-02-27 15:09:14 +00:00
Giampaolo Rodolà
63390b3cbb
Merged revisions 88581 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r88581 | giampaolo.rodola | 2011-02-25 15:50:57 +0100 (ven, 25 feb 2011) | 1 line
(issue 11232) - fix asyncore documentation issue (patch by Sandro Tosi)
........
2011-02-25 14:55:52 +00:00
Georg Brandl
3c865231c1
Markup backport fix.
2011-02-25 11:27:48 +00:00
Georg Brandl
280460271d
Merged revisions 87627,87638,87760,87986,88108,88115,88165,88263,88329,88364-88365,88423-88424 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r87627 | georg.brandl | 2011-01-02 15:23:43 +0100 (So, 02 Jan 2011) | 1 line
#1665333 : add more docs for optparse.OptionGroup.
........
r87638 | georg.brandl | 2011-01-02 20:07:51 +0100 (So, 02 Jan 2011) | 1 line
Fix code indentation.
........
r87760 | georg.brandl | 2011-01-05 11:59:48 +0100 (Mi, 05 Jan 2011) | 1 line
Fix duplicate end tag.
........
r87986 | georg.brandl | 2011-01-13 08:31:18 +0100 (Do, 13 Jan 2011) | 1 line
Fix the example output of count().
........
r88108 | georg.brandl | 2011-01-19 09:42:03 +0100 (Mi, 19 Jan 2011) | 1 line
Suppress trailing spaces in table paragraphs.
........
r88115 | georg.brandl | 2011-01-19 21:05:49 +0100 (Mi, 19 Jan 2011) | 1 line
#10944 : add c_bool to types table.
........
r88165 | georg.brandl | 2011-01-24 20:53:18 +0100 (Mo, 24 Jan 2011) | 1 line
Typo fix.
........
r88263 | georg.brandl | 2011-01-30 13:19:35 +0100 (So, 30 Jan 2011) | 1 line
#10680 : fix mutually exclusive arguments in argument groups.
........
r88329 | georg.brandl | 2011-02-03 08:08:25 +0100 (Do, 03 Feb 2011) | 1 line
Punctuation typos.
........
r88364 | georg.brandl | 2011-02-07 13:10:46 +0100 (Mo, 07 Feb 2011) | 1 line
#11138 : fix order of fill and align specifiers.
........
r88365 | georg.brandl | 2011-02-07 13:13:58 +0100 (Mo, 07 Feb 2011) | 1 line
#8691 : document that right alignment is default for numbers.
........
r88423 | georg.brandl | 2011-02-15 13:41:17 +0100 (Di, 15 Feb 2011) | 1 line
Apply logging SocketHandler doc update by Vinay.
........
r88424 | georg.brandl | 2011-02-15 13:44:43 +0100 (Di, 15 Feb 2011) | 1 line
Remove editing slip.
........
2011-02-25 11:01:04 +00:00
Georg Brandl
28dadd988b
Merged revisions 87050,87101,87146,87156,87172,87175,87371,87378,87522-87524,87526,87530-87535 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r87050 | georg.brandl | 2010-12-04 18:09:30 +0100 (Sa, 04 Dez 2010) | 1 line
Fix typo.
........
r87101 | georg.brandl | 2010-12-06 23:02:48 +0100 (Mo, 06 Dez 2010) | 1 line
Remove visible XXX comments.
........
r87146 | georg.brandl | 2010-12-09 19:08:43 +0100 (Do, 09 Dez 2010) | 1 line
Fix "seperate".
........
r87156 | georg.brandl | 2010-12-10 11:01:44 +0100 (Fr, 10 Dez 2010) | 1 line
#10668 : fix wrong call of __init__.
........
r87172 | georg.brandl | 2010-12-11 20:10:30 +0100 (Sa, 11 Dez 2010) | 1 line
Avoid AttributeError(_closed) when a TemporaryDirectory is deallocated whose mkdtemp call failed.
........
r87175 | georg.brandl | 2010-12-11 23:19:34 +0100 (Sa, 11 Dez 2010) | 1 line
Fix markup.
........
r87371 | georg.brandl | 2010-12-18 17:21:58 +0100 (Sa, 18 Dez 2010) | 1 line
Fix typo.
........
r87378 | georg.brandl | 2010-12-18 18:51:28 +0100 (Sa, 18 Dez 2010) | 1 line
#10723 : add missing builtin exceptions.
........
r87522 | georg.brandl | 2010-12-28 10:16:12 +0100 (Di, 28 Dez 2010) | 1 line
Replace sys.maxint mention by sys.maxsize.
........
r87523 | georg.brandl | 2010-12-28 10:18:24 +0100 (Di, 28 Dez 2010) | 1 line
Remove confusing paragraph -- this is relevant only to advanced users anyway and does not belong into the tutorial.
........
r87524 | georg.brandl | 2010-12-28 10:29:19 +0100 (Di, 28 Dez 2010) | 1 line
Fix advice: call PyType_Ready to fill in ob_type of custom types.
........
r87526 | georg.brandl | 2010-12-28 11:38:33 +0100 (Di, 28 Dez 2010) | 1 line
#10777 : fix iteration over dict keys while mutating the dict.
........
r87530 | georg.brandl | 2010-12-28 12:06:07 +0100 (Di, 28 Dez 2010) | 1 line
#10767 : update README in crashers; not all may have a bug entry and/or be fixed.
........
r87531 | georg.brandl | 2010-12-28 12:08:17 +0100 (Di, 28 Dez 2010) | 1 line
#10742 : document readonly attribute of memoryviews.
........
r87532 | georg.brandl | 2010-12-28 12:15:49 +0100 (Di, 28 Dez 2010) | 1 line
#10781 : clarify that *encoding* is not a parameter for Node objects in general.
........
r87533 | georg.brandl | 2010-12-28 12:38:12 +0100 (Di, 28 Dez 2010) | 1 line
Remove history; adapt a bit more to reST, since this will once be part of the dev guide.
........
r87534 | georg.brandl | 2010-12-28 12:48:53 +0100 (Di, 28 Dez 2010) | 1 line
Rewrap.
........
r87535 | georg.brandl | 2010-12-28 12:49:41 +0100 (Di, 28 Dez 2010) | 1 line
#10739 : document that on Windows, socket.makefile() does not make a file that has a true file descriptor usable where such a thing is expected.
........
2011-02-25 10:50:32 +00:00
Georg Brandl
52f839540c
Merged revisions 86881,86887,86913-86915,86933,86943,86960,86964,86974,86980,86996,87008 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r86881 | georg.brandl | 2010-11-30 08:43:28 +0100 (Di, 30 Nov 2010) | 1 line
#10584 : fix bad links.
........
r86887 | georg.brandl | 2010-11-30 15:57:54 +0100 (Di, 30 Nov 2010) | 1 line
Fix typo.
........
r86913 | georg.brandl | 2010-12-01 16:32:43 +0100 (Mi, 01 Dez 2010) | 1 line
Add missing word, and add a better reference to the actual function.
........
r86914 | georg.brandl | 2010-12-01 16:36:33 +0100 (Mi, 01 Dez 2010) | 1 line
#10594 : fix parameter names in PyList API docs.
........
r86915 | georg.brandl | 2010-12-01 16:44:25 +0100 (Mi, 01 Dez 2010) | 1 line
Fix some markup and style in the unittest docs.
........
r86933 | georg.brandl | 2010-12-02 19:02:01 +0100 (Do, 02 Dez 2010) | 1 line
#10597 : fix Py_SetPythonHome docs by pointing to where the meaning of PYTHONHOME is already documented.
........
r86943 | georg.brandl | 2010-12-02 23:35:25 +0100 (Do, 02 Dez 2010) | 1 line
Re-add accidentally removed line.
........
r86960 | georg.brandl | 2010-12-03 08:55:44 +0100 (Fr, 03 Dez 2010) | 1 line
#10360 : catch TypeError in WeakSet.__contains__, just like WeakKeyDictionary does.
........
r86964 | georg.brandl | 2010-12-03 10:58:38 +0100 (Fr, 03 Dez 2010) | 1 line
#10549 : fix interface of docclass() for text documenter.
........
r86974 | georg.brandl | 2010-12-03 16:30:09 +0100 (Fr, 03 Dez 2010) | 1 line
Markup consistency fixes.
........
r86980 | georg.brandl | 2010-12-03 18:19:27 +0100 (Fr, 03 Dez 2010) | 1 line
Fix punctuation.
........
r86996 | georg.brandl | 2010-12-03 20:56:42 +0100 (Fr, 03 Dez 2010) | 1 line
Fix indentation.
........
r87008 | georg.brandl | 2010-12-04 10:04:04 +0100 (Sa, 04 Dez 2010) | 1 line
Fix typo.
........
2011-02-25 10:39:23 +00:00
Éric Araujo
8ff851b468
Link from deprecated sets module to builtins set and frozenset ( #11238 )
2011-02-18 17:47:23 +00:00
Raymond Hettinger
97b31954b7
Fix example for itertools.count().
2011-02-14 06:03:41 +00:00
Georg Brandl
ba516cb83e
Fix markup problems.
2011-02-12 07:32:17 +00:00
R. David Murray
46c4e4709a
Merged revisions 88402 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r88402 | r.david.murray | 2011-02-11 17:37:16 -0500 (Fri, 11 Feb 2011) | 2 lines
Fix argument name typo in compileall docs.
........
2011-02-11 22:54:34 +00:00
R. David Murray
561b96f98c
Merged revisions 86542,87136,87216,87221,87228,87256,87337-87338,87372,87516,87571,88164 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r86542 | r.david.murray | 2010-11-19 22:48:58 -0500 (Fri, 19 Nov 2010) | 2 lines
Make test class name unique so that both test classes run.
........
r87136 | r.david.murray | 2010-12-08 17:53:00 -0500 (Wed, 08 Dec 2010) | 6 lines
Have script_helper._assert_python strip refcount strings from stderr.
This makes the output of the function and those that depend on it
independent of whether or not they are being run under a debug
build.
........
r87216 | r.david.murray | 2010-12-13 17:50:30 -0500 (Mon, 13 Dec 2010) | 2 lines
#10698 : fix typo in example.
........
r87221 | r.david.murray | 2010-12-13 19:55:46 -0500 (Mon, 13 Dec 2010) | 4 lines
#10699 : fix docstring for tzset: it does not take a parameter
Thanks to Garrett Cooper for the fix.
........
r87228 | r.david.murray | 2010-12-13 21:25:43 -0500 (Mon, 13 Dec 2010) | 2 lines
Turn on regrtest -W (rerun immediately) option for Windows, too.
........
r87256 | r.david.murray | 2010-12-14 21:19:14 -0500 (Tue, 14 Dec 2010) | 2 lines
#10705 : document what the values of debuglevel are and mean.
........
r87337 | r.david.murray | 2010-12-17 11:11:40 -0500 (Fri, 17 Dec 2010) | 2 lines
#10559 : provide instructions for accessing sys.argv when first mentioned.
........
r87338 | r.david.murray | 2010-12-17 11:29:07 -0500 (Fri, 17 Dec 2010) | 2 lines
#10454 : clarify the compileall docs and help messages.
[changes to compileall.py were not backported, only the doc changes]
........
r87372 | r.david.murray | 2010-12-18 11:39:06 -0500 (Sat, 18 Dec 2010) | 2 lines
#10728 : the default for printing help is sys.stdout, not stderr.
........
r87516 | r.david.murray | 2010-12-27 15:09:32 -0500 (Mon, 27 Dec 2010) | 5 lines
#7056 : runtest and runtest_inner don't use testdir, so drop it from their sigs
I've only tested regular runs and -j runs. If I've broken anything
else I'm sure I'll hear about it sooner or later.
........
r87571 | r.david.murray | 2010-12-29 14:06:48 -0500 (Wed, 29 Dec 2010) | 2 lines
Fix same typo in docs.
........
r88164 | r.david.murray | 2011-01-24 14:34:58 -0500 (Mon, 24 Jan 2011) | 12 lines
#10960 : fix 'stat' links, link to lstat from stat, general tidy of stat doc.
Original patch by Michal Nowikowski, with some additions and wording
fixes by me.
I changed the wording from 'Performs a stat system call' to 'Performs
the equivalent of a stat system call', since on Windows there are no
stat/lstat system calls involved. I also extended Michal's breakout
of the attributes into a list to the other paragraphs, and rearranged
the order of the paragraphs in the 'stat' docs to make it flow
better and put it in what I think is a more logical/useful order.
........
2011-02-11 17:25:54 +00:00
Antoine Pitrou
e9bd9dbc73
Merged revisions 88371 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r88371 | antoine.pitrou | 2011-02-07 16:58:11 +0100 (lun., 07 févr. 2011) | 3 lines
Clarify that IMAP4() implicitly calls open(), and that logout() implicitly calls shutdown().
........
2011-02-07 16:03:47 +00:00
Gregory P. Smith
e3e967f2b3
Merged revisions 88352 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r88352 | gregory.p.smith | 2011-02-05 13:47:25 -0800 (Sat, 05 Feb 2011) | 3 lines
issue7678 - Properly document how to replace a shell pipeline so that SIGPIPE
happens when the end exits before the beginning.
........
2011-02-05 21:49:56 +00:00
Antoine Pitrou
893e7c6184
Merged revisions 88334 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r88334 | antoine.pitrou | 2011-02-04 21:11:11 +0100 (ven., 04 févr. 2011) | 3 lines
Mention that seek and tell over a TextIOWrapper can be very slow.
........
2011-02-04 20:17:53 +00:00
Éric Araujo
54274ad96a
Merged revisions 86236,86240,86332,86340,87271,87273,87447 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
To comply with the 2.x doc style, the methods in trace.rst use brackets around
optional arguments. The rest is a mostly straight merge, modulo support changed
to test_support and use of the old super call style in test_tuple.
........
r86236 | eric.araujo | 2010-11-06 03:44:43 +0100 (sam., 06 nov. 2010) | 2 lines
Make sure each test can be run standalone (./python Lib/distutils/tests/x.py)
........
r86240 | eric.araujo | 2010-11-06 05:11:59 +0100 (sam., 06 nov. 2010) | 2 lines
Prevent ResourceWarnings in test_gettext
........
r86332 | eric.araujo | 2010-11-08 19:15:17 +0100 (lun., 08 nov. 2010) | 4 lines
Add missing NEWS entry for a fix committed by Senthil.
All recent modifications to distutils should now be covered in NEWS.
........
r86340 | eric.araujo | 2010-11-08 22:48:23 +0100 (lun., 08 nov. 2010) | 2 lines
This was actually fixed for the previous alpha.
........
r87271 | eric.araujo | 2010-12-15 20:09:58 +0100 (mer., 15 déc. 2010) | 2 lines
Improve trace documentation (#9264 ). Patch by Eli Bendersky.
........
r87273 | eric.araujo | 2010-12-15 20:30:15 +0100 (mer., 15 déc. 2010) | 2 lines
Use nested method directives, rewrap long lines, fix whitespace.
........
r87447 | eric.araujo | 2010-12-23 20:13:05 +0100 (jeu., 23 déc. 2010) | 2 lines
Fix typo in superclass method name
........
2011-02-03 00:12:18 +00:00
Brian Curtin
37c4a723a4
Merged revisions 88281 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r88281 | brian.curtin | 2011-01-31 13:35:02 -0600 (Mon, 31 Jan 2011) | 2 lines
#11083 typo: RuntimeException -> RuntimeError
........
2011-01-31 19:55:14 +00:00
Vinay Sajip
2e88104780
Issue 11008: docs updated to show versionadded for dictConfig.
2011-01-27 19:14:16 +00:00
Raymond Hettinger
32074e337e
Add note advising that 'filter' be used as a keyword-argument.
2011-01-26 20:40:32 +00:00
Terry Reedy
51581de168
Issue #11000 ast.parse doc fix (r88172)
2011-01-24 21:48:11 +00:00
Alexander Belopolsky
7e8fbd2b7d
Merged revisions 88114 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r88114 | alexander.belopolsky | 2011-01-19 14:53:30 -0500 (Wed, 19 Jan 2011) | 5 lines
Issue #10934 : Fixed and expanded Internaldate2tuple() and
Time2Internaldate() documentation. Thanks Joe Peterson for the report
and the original patch.
........
2011-01-19 21:48:20 +00:00
Eli Bendersky
f274eea02c
Issue #10902 : Fix reference to run* methods
2011-01-14 07:50:27 +00:00
Georg Brandl
585bbb98a7
Merged revisions 87890 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r87890 | georg.brandl | 2011-01-09 10:04:08 +0100 (So, 09 Jan 2011) | 1 line
Wrap some long examples and signatures.
........
2011-01-09 09:33:09 +00:00
Georg Brandl
cbb2e49c3c
Hand-port parts of r87789.
2011-01-09 08:04:37 +00:00
Georg Brandl
335d4f5eb4
Merged revisions 87807,87820,87831,87859 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r87807 | georg.brandl | 2011-01-06 20:28:18 +0100 (Do, 06 Jan 2011) | 1 line
#10846 : fix typo.
........
r87820 | georg.brandl | 2011-01-07 19:28:45 +0100 (Fr, 07 Jan 2011) | 1 line
#10856 : document (Base)Exception.args better.
........
r87831 | georg.brandl | 2011-01-07 21:58:25 +0100 (Fr, 07 Jan 2011) | 1 line
Fix indent.
........
r87859 | georg.brandl | 2011-01-08 10:45:43 +0100 (Sa, 08 Jan 2011) | 1 line
#10855 : document close() semantics of wave objects.
........
2011-01-09 07:58:45 +00:00