Commit Graph

136 Commits

Author SHA1 Message Date
Serhiy Storchaka 26d936a71e Issue #19795: Improved markup of True/False constants. 2013-11-29 12:16:53 +02:00
Serhiy Storchaka ad16b725bc Issue #19190: Improve cross-references in builtin types and functions documentation. 2013-10-09 14:02:14 +03:00
Benjamin Peterson b44c8619fe document that various functions that parse from source will interpret things as latin-1 (closes #18870) 2013-09-01 19:06:35 -04:00
Terry Jan Reedy 589cb111b5 Issue #17418: specify that buffer sizes are bytes. 2013-03-16 15:55:53 -04:00
Ezio Melotti 5f52246f75 #14489: fix wrong link. 2013-03-10 04:28:28 +02:00
Ezio Melotti ed5fba2ad9 #17035: use new style classes in classmethod/staticmethod examples. Patch by Berker Peksag. 2013-02-22 07:34:52 +02:00
Ezio Melotti 01560de287 #16503: clarify "apply" docs. 2012-11-18 21:23:44 +02:00
Chris Jerdonek 9e173ebde2 Link to "XRange Type" section in xrange() built-in function documentation. 2012-11-14 02:13:28 -08: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 b8fbff889f #16210: combine the two type() docs. Patch by Pete Sevander. 2012-10-24 23:01:30 +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 ad4b000179 Issue #14783: Backport changes from 3.2. 2012-10-07 20:37:54 -07: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
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
Mark Dickinson 39e0fb01ef Issue 15985: fix round argument names in documentation. Thanks Chris Jerdonek. 2012-09-20 20:57:37 +01: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 c7b8f809e7 #15543: reflow paragraphs. 2012-08-15 11:22:58 -04:00
R David Murray 5618aaaafe #15543: glossary entry for and 'universal newlines', and links to it.
Patch by Chris Jerdonek.
2012-08-15 11:15:39 -04:00
Benjamin Peterson 359b5032f6 make documented file() kw names and actual ones agree (closes #15572)
Patch by Daniel Ellis.
2012-08-07 11:57:47 -07:00
R David Murray 59488d233b Closes #9254: backport __import__ docstring/doc mentions of importlib.
Patch by Éric Araujo.
2012-07-18 19:44:08 -04:00
Terry Jan Reedy 45ed012433 Issue #13557: Clarify effect of giving two different namespaces to exec or
execfile().
2012-07-08 17:35:26 -04:00
Hynek Schlawack e58ce01f30 #14804: Remove [] around optional arguments with default values
Mostly just mechanical removal of []. In some rare cases I've pulled the
default value up into the argument list.
2012-05-22 10:27:40 +02:00
Sandro Tosi 1d710b6a84 backport 7a05cb3beddf to 2.7 2012-05-07 21:56:24 +02:00
Georg Brandl b45c5e2d0e Closes #14489: correct link target. 2012-04-05 09:04:40 +02:00
Mark Dickinson 5081957642 Closes #9574: Note that complex constructor doesn't allow whitespace around central operator. 2012-03-10 16:09:35 +00:00
Raymond Hettinger 65de77ed9e Clean-up docs for input() 2012-02-02 00:52:33 -08:00
Raymond Hettinger 6d837a3769 Add pure python equivalent code for reduce(). 2012-02-02 00:48:46 -08:00
Ezio Melotti 51ab3519d8 Move a space. 2012-01-21 16:40:03 +02:00
Sandro Tosi 98ed08f24e update to new C roles and directives 2012-01-14 16:42:02 +01:00
Terry Jan Reedy 150122a5a2 #11633 about buffering of print 2012-01-14 00:06:37 -05:00
Raymond Hettinger 36cdca1277 Clarify that vars() doesn't place extra restrictions on __dict__. 2012-01-05 23:23:52 -08:00
Éric Araujo 972ba9e41f Add missing versionadded (fixes #12392) 2011-11-05 17:55:03 +01:00
Éric Araujo e0054c51c7 Link isinstance/issubclass to the ABC glossary entry (#12256) 2011-08-19 09:15:47 +02:00
Éric Araujo 5dd034b84f Minor doc addition for clarity 2011-05-27 04:42:47 +02:00
Ezio Melotti 8171cf52b6 #12642: fix args names in open() doc. 2011-07-27 08:48:52 +03:00
Ezio Melotti b952413499 Fix markup. 2011-07-21 11:38:13 +03:00
Raymond Hettinger 320b91495a Issue 11889: Clarify docs for enumerate. 2011-06-25 14:57:06 +02: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
Eli Bendersky 29f6efa844 Issue 12003: fixing error in xrange alternative sample 2011-05-23 06:10:26 +03:00
Georg Brandl 26946ecaed Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r85548 | georg.brandl | 2010-10-15 21:46:19 +0200 (Fr, 15 Okt 2010) | 1 line

  #10072: assume a bit less knowledge of the FTP protocol in the ftplib docs.
........
  r85572 | georg.brandl | 2010-10-16 20:51:05 +0200 (Sa, 16 Okt 2010) | 1 line

  #10122: typo fix.
........
  r85573 | georg.brandl | 2010-10-16 20:53:08 +0200 (Sa, 16 Okt 2010) | 1 line

  #10124: typo fix.
........
  r85606 | georg.brandl | 2010-10-17 08:32:59 +0200 (So, 17 Okt 2010) | 1 line

  #10058: tweak wording about exception returns.
........
  r85609 | georg.brandl | 2010-10-17 11:19:03 +0200 (So, 17 Okt 2010) | 1 line

  #8556: use less confusing mapping key in example.
........
  r85610 | georg.brandl | 2010-10-17 11:23:05 +0200 (So, 17 Okt 2010) | 1 line

  #8686: remove potentially confusing wording that does not add any value.
........
  r85611 | georg.brandl | 2010-10-17 11:33:24 +0200 (So, 17 Okt 2010) | 1 line

  #8811: small fixes to sqlite3 docs.
........
  r85612 | georg.brandl | 2010-10-17 11:37:54 +0200 (So, 17 Okt 2010) | 1 line

  #8855: add shelve security warning.
........
  r85614 | georg.brandl | 2010-10-17 11:46:11 +0200 (So, 17 Okt 2010) | 1 line

  #8968: add actual name of token constants.
........
  r85615 | georg.brandl | 2010-10-17 12:05:13 +0200 (So, 17 Okt 2010) | 1 line

  #459007: merge info from PC/getpathp.c and using/windows.rst to document the forming of sys.path under Windows.
........
  r85616 | georg.brandl | 2010-10-17 12:07:29 +0200 (So, 17 Okt 2010) | 1 line

  Fix copy-paste error in example.
........
2010-11-26 07:42:15 +00:00
Ezio Melotti bf8484e77d Merged revisions 86732 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r86732 | ezio.melotti | 2010-11-24 22:18:02 +0200 (Wed, 24 Nov 2010) | 1 line

  #10299: Add a table that lists all the built-in functions in functions.rst
........
2010-11-24 21:54:47 +00:00
Antoine Pitrou e8803e7524 Issue #8340: document bytearray in Python 2.7. 2010-11-20 19:35:42 +00:00
Éric Araujo d5cd1ff7da Merged revisions 86249 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r86249 | eric.araujo | 2010-11-06 07:30:16 +0100 (sam., 06 nov. 2010) | 2 lines

  Fix typo
........
2010-11-06 06:31:54 +00:00
Raymond Hettinger 15c2cec4fd Issue 7447: Improve docs for sum(). 2010-10-31 21:28:53 +00:00
Georg Brandl 21946afe3f Merged revisions 82798,82805,83659,83977,84015,84018,84141,84264,84326-84327,84480,84482,84484,84530-84531,84553,84619,84915-84916 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r82798 | georg.brandl | 2010-07-11 11:23:11 +0200 (So, 11 Jul 2010) | 1 line

  #6774: explain shutdown() behavior varying with platform.
........
  r82805 | georg.brandl | 2010-07-11 11:42:10 +0200 (So, 11 Jul 2010) | 1 line

  #7935: cross-reference to ast.literal_eval() from eval() docs.
........
  r83659 | georg.brandl | 2010-08-03 14:06:29 +0200 (Di, 03 Aug 2010) | 1 line

  Terminology fix: exceptions are raised, except in generator.throw().
........
  r83977 | georg.brandl | 2010-08-13 17:10:49 +0200 (Fr, 13 Aug 2010) | 1 line

  Fix copy-paste error.
........
  r84015 | georg.brandl | 2010-08-14 17:44:34 +0200 (Sa, 14 Aug 2010) | 1 line

  Add some maintainers.
........
  r84018 | georg.brandl | 2010-08-14 17:48:49 +0200 (Sa, 14 Aug 2010) | 1 line

  Typo fix.
........
  r84141 | georg.brandl | 2010-08-17 16:11:59 +0200 (Di, 17 Aug 2010) | 1 line

  Markup nits.
........
  r84264 | georg.brandl | 2010-08-22 22:23:38 +0200 (So, 22 Aug 2010) | 1 line

  #9649: fix default value description.
........
  r84326 | georg.brandl | 2010-08-26 16:30:15 +0200 (Do, 26 Aug 2010) | 1 line

  #9689: add links from overview to in-depth class API descriptions.
........
  r84327 | georg.brandl | 2010-08-26 16:30:56 +0200 (Do, 26 Aug 2010) | 1 line

  #9681: typo.
........
  r84480 | georg.brandl | 2010-09-04 00:33:27 +0200 (Sa, 04 Sep 2010) | 1 line

  More inclusive title.
........
  r84482 | georg.brandl | 2010-09-04 00:40:02 +0200 (Sa, 04 Sep 2010) | 1 line

  #9760: clarify what context expression is.
........
  r84484 | georg.brandl | 2010-09-04 00:49:27 +0200 (Sa, 04 Sep 2010) | 1 line

  Fix missing word.
........
  r84530 | georg.brandl | 2010-09-05 19:07:12 +0200 (So, 05 Sep 2010) | 1 line

  #9747: fix copy-paste error in getresgid() doc.
........
  r84531 | georg.brandl | 2010-09-05 19:09:18 +0200 (So, 05 Sep 2010) | 1 line

  #9776: fix some spacing.
........
  r84553 | georg.brandl | 2010-09-06 08:49:07 +0200 (Mo, 06 Sep 2010) | 1 line

  #9780: both { and } are not valid fill characters.
........
  r84619 | georg.brandl | 2010-09-08 12:43:45 +0200 (Mi, 08 Sep 2010) | 1 line

  Add Lukasz.
........
  r84915 | georg.brandl | 2010-09-20 08:27:02 +0200 (Mo, 20 Sep 2010) | 1 line

  Fix typo.
........
  r84916 | georg.brandl | 2010-09-20 08:29:01 +0200 (Mo, 20 Sep 2010) | 1 line

  Mention % as string formatting.
........
2010-10-06 09:28:45 +00:00
Georg Brandl 7d4bfb338d Merged revisions 83536,83546-83548,83550,83554-83555,83558,83563,83565,83571,83574-83575 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r83536 | georg.brandl | 2010-08-02 19:49:25 +0200 (Mo, 02 Aug 2010) | 1 line

  #8578: mention danger of not incref'ing weak referenced object.
........
  r83546 | georg.brandl | 2010-08-02 21:16:34 +0200 (Mo, 02 Aug 2010) | 1 line

  #7973: Fix distutils options spelling.
........
  r83547 | georg.brandl | 2010-08-02 21:19:26 +0200 (Mo, 02 Aug 2010) | 1 line

  #7386: add example that shows that trailing path separators are stripped.
........
  r83548 | georg.brandl | 2010-08-02 21:23:34 +0200 (Mo, 02 Aug 2010) | 1 line

  #8172: how does one use a property?
........
  r83550 | georg.brandl | 2010-08-02 21:32:43 +0200 (Mo, 02 Aug 2010) | 1 line

  #9451: strengthen warning about __*__ special name usage.
........
  r83554 | georg.brandl | 2010-08-02 21:43:05 +0200 (Mo, 02 Aug 2010) | 1 line

  #7280: note about nasmw.exe.
........
  r83555 | georg.brandl | 2010-08-02 21:44:48 +0200 (Mo, 02 Aug 2010) | 1 line

  #8861: remove unused variable.
........
  r83558 | georg.brandl | 2010-08-02 22:05:19 +0200 (Mo, 02 Aug 2010) | 1 line

  #8648: document UTF-7 codec functions.
........
  r83563 | georg.brandl | 2010-08-02 22:21:21 +0200 (Mo, 02 Aug 2010) | 1 line

  #9037: add example how to raise custom exceptions from C code.
........
  r83565 | georg.brandl | 2010-08-02 22:27:20 +0200 (Mo, 02 Aug 2010) | 1 line

  #9111: document that do_help() looks at docstrings.
........
  r83571 | georg.brandl | 2010-08-02 22:44:34 +0200 (Mo, 02 Aug 2010) | 1 line

  Clarify that abs() is not a namespace.
........
  r83574 | georg.brandl | 2010-08-02 22:47:56 +0200 (Mo, 02 Aug 2010) | 1 line

  #6867: epoll.register() returns None.
........
  r83575 | georg.brandl | 2010-08-02 22:52:10 +0200 (Mo, 02 Aug 2010) | 1 line

  #9238: zipfile does handle archive comments.
........
2010-08-02 21:44:25 +00:00
Mark Dickinson 19746cb322 Merged revisions 83277 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r83277 | mark.dickinson | 2010-07-30 14:13:02 +0100 (Fri, 30 Jul 2010) | 1 line

  Add note about surprising behaviour from round function.
........
2010-07-30 13:16:07 +00:00