Commit Graph

12009 Commits

Author SHA1 Message Date
Georg Brandl fbe84d92ab Clarify that PyErr_NewException creates an exception *class*, not instance. 2011-07-13 15:59:24 +02: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
Ezio Melotti 99c9c8534f #11669: rephrase footnote in the Compound Statements page. 2011-06-26 11:25:28 +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 fd1cb59618 Issue 12086: add example showing how to use name mangling. 2011-06-25 16:28:07 +02: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
Senthil Kumaran 832288ca18 merge 3.2 - Fix closes Issue12359 - Removing a confusing sentence from the previous change. 2011-06-20 07:34:48 -07:00
Senthil Kumaran 98fec3aa5e Fix issue12359. Minor doc update on import module description. 2011-06-19 17:45:36 -07: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
Eli Bendersky 761473f28a Issue #12223: Typo fix in datamodel docs 2011-06-10 10:36:34 +03:00
Éric Araujo 5cf8660f0b Fix a few misuses of :option: I missed in r86521.
Extract of the commit message:

  Fix usage of :option: in the docs (#9312).

  :option: is used to create a link to an option of python, not to mark
  up any instance of any arbitrary command-line option.  These were
  changed to ````.
2011-06-09 14:26:10 +02:00
Éric Araujo a65a880cd2 Add examples that work on Windows to distutils docs (#1626300) 2011-06-08 01:11:36 +02:00
Éric Araujo 3322a25532 Remove outdated bit of advice (c882b5ff92d9 follow-up) 2011-06-04 18:35:04 +02:00
Éric Araujo d66d95cdd0 Document working dir for “make html” (#12249). Patch by Tshepang Lekhonkhobe. 2011-06-03 19:25:58 +02: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
Éric Araujo 346d8609a1 Fix markup: arguments in a class directive are __init__ arguments, not base classes 2011-05-31 21:50:22 +02:00
Éric Araujo 28ef3c4726 Re-add missing doc stub for the distutils check command 2011-05-29 00:31:30 +02:00
Éric Araujo bee18a31ad Backport doc improvements for distutils.cmd.Command (#9223).
Original commit by Georg Brandl.
2011-05-29 00:11:59 +02:00
Éric Araujo 5dd034b84f Minor doc addition for clarity 2011-05-27 04:42:47 +02:00
Éric Araujo ec464cf9bb Add missing reST target to one heading in the tutorial 2011-07-29 11:35:27 +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
Éric Araujo 345fff3de8 Remove mentions of previous license in profile module (#12417 followup) 2011-07-28 22:27:28 +02:00
Éric Araujo 18176f06b5 Fix two typos 2011-05-25 18:06:16 +02: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
Eli Bendersky e91b305d28 Issue 12126: removing incorrect claim about return value of select 2011-05-22 06:49:01 +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 52f63eabeb #12072: add missing parenthesis in the doc. Patch by Sandro Tosi. 2011-05-20 15:04:38 +03:00
Ezio Melotti bfbd1a2fd4 #12092: backport rephrasing of a paragraph in the tutorial. 2011-05-17 05:39:22 +03:00
Ezio Melotti b429c57481 #12093: fix typo in struct doc. Patch by Sandro Tosi. 2011-05-17 05:17:35 +03:00
Georg Brandl 11041f0af9 Port #6498 fix: fix several misspellings of "SystemExit" as "SystemError". 2011-05-15 08:50:32 +02:00
Ezio Melotti 9b323a521c #11979: improve wording and markup in sockets howto. Patch by Xavier Morel. 2011-05-14 09:17:52 +03:00
Georg Brandl 073070629b #12061: remove duplicate glossary entry. 2011-05-12 07:47:06 +02: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
Raymond Hettinger 351761236a Issue 12047: Expand the style guide. 2011-05-10 00:39:02 -07: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 fe12aa67fc #11997: fix typo in init.rst. 2011-05-05 14:19:48 +03:00
Brian Curtin 1602ec109b Fix #11834. Correct site-packages paths.
Patch by Bryce Verdier.
2011-05-03 22:01:53 -05: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 cfa8483051 Branch merge 2011-05-02 13:36:18 +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
Georg Brandl 12b8fcfc45 Split combined code/doctest code blocks in two blocks, to enable proper highlighting. 2011-05-01 22:36:31 +02:00
Éric Araujo 2a53d33dc6 Fix wording 2011-05-01 02:15:03 +02:00
R David Murray dd6ab85384 #11883: fix email examples by adding 'localhost' to SMTP constructor calls 2011-04-30 17:26:02 -04:00
R David Murray dcaacbf1ef #11901: post-commit review fixes per Georg Brandl 2011-04-30 16:34:35 -04:00
Benjamin Peterson 2a7a3ee39a fix function name in example (closes #11966) 2011-04-30 13:14:56 -05:00
Eli Bendersky b22f39cb94 fix formatting, :c:func: --> :cfunc: 2011-04-30 09:02:12 +03:00
Eli Bendersky 11d1171ecf Issue #10912: add clarification for PyObject_RichCompareBool comparing identical objects 2011-04-30 08:51:55 +03: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
Raymond Hettinger bd0933a687 Issue #11940: Update external link. 2011-04-27 16:34:07 -07:00
Ezio Melotti cd12746ce9 #11942: Fix return type of Py_AddPendingCall. Patch by Sandro Tosi. 2011-04-28 00:48:46 +03: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 ffdf94ae79 Fix wrong function name. Noticed by Clive Darke. 2011-04-20 21:29:31 +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 8e4eeef4ee #11865: fix typo in init.rst. 2011-04-18 10:11:21 +03:00
Éric Araujo 46c09da3ca Advertise nesting directives for class/method and class/data combos.
Also fix a typo and a misleading example (method used to describe function).
2011-04-16 23:47:53 +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 65c620d0c7 #11843: remove duplicate line from table in distutil doc. 2011-04-15 18:05:09 +03: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 020f6508c1 #11840: Improve c-api/unicode documentation. Patch by Sandro Tosi. 2011-04-14 07:39: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 10ab95a271 Remove untrue statement from tutorial 2011-03-26 01:26:08 +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 1fd26525a4 Issue #10771: Clarify that descriptors get used in an *owner* class or one of its parents. 2011-03-22 17:51:57 -07:00
Raymond Hettinger 405a4717e1 Issue 10787: Document the probability density function for random.gammavariate. 2011-03-22 15:52:46 -07:00
Raymond Hettinger b76f6200d2 Issue 10988: fix description of super's descriptor call. 2011-03-22 15:28:45 -07:00
Éric Araujo 4fbd88a078 Fix typo spotted by Sandro Tosi 2011-03-22 21:45:42 +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
Antoine Pitrou 8b78a9d8ca Remove documentation to non-existent function PyObject_CopyToObject (fixes #11478) 2011-03-13 19:35:04 +01:00
Eli Bendersky ec40bab21e Issue #11426: use 'with' statements on open files in CSV examples 2011-03-13 08:45:19 +02:00
Ezio Melotti dd6833d20a Fix markup in inputoutput.rst. 2011-03-13 02:13:08 +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
Gregory P. Smith 28d57c0d5c Explicitly mention that people should not depend on finalization of
objects to happen immediately.
2011-03-10 11:49:27 -08: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 f125a9a9aa #11239: add } to list of metacharacters (it is only a metacharacter sometimes, ie. when closing a {n,m} group, but so is ]. 2011-03-06 11:07:11 +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
Georg Brandl cdbc6967e8 #11405: do not reference the string module again for its deprecated functions, only for Template class. 2011-03-06 10:56:18 +01:00
Georg Brandl c9497ba06e #11400: remove reference to pre-1.5 assignment behavior. 2011-03-06 10:48:43 +01:00
Georg Brandl faa9ad2a46 Add updated .hgeol file and fix newlines in the 2.7 branch. 2011-03-05 15:06:13 +01:00
Georg Brandl b5c93e9cad Add .hgeol file and fix newlines in the 2.6 branch. 2011-03-05 15:04:01 +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
Éric Araujo af8728a352 Merged revisions 88613 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r88613 | eric.araujo | 2011-02-25 22:40:34 +0100 (ven., 25 févr. 2011) | 2 lines

  Add missing read() in distutils doc.
........
2011-02-25 21:47:55 +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