Commit Graph

142 Commits

Author SHA1 Message Date
Éric Araujo 1079bdfde3 Merge 3.2 2011-10-05 01:52:45 +02:00
Éric Araujo 58a9153c9f 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 '3.2' is a CPython detail and
  should not be advertised (see #9442), even if some stdlib modules
  currently rely on that detail.
2011-10-05 01:28:24 +02:00
Éric Araujo da27263b4a Move doc of sys.dont_write_bytecode to make all attributes sorted again 2011-10-05 01:17:38 +02:00
Éric Araujo 525b1e9dd4 Fix minor wording issue.
sys.maxunicode is not called and thus does not return anything; it *is*
something.  (I checked the doc quickly to see if it tells that
expression return things but found nothing.)

I also removed markup that would just generate a useless link to the
enclosing section.
2011-10-05 01:06:31 +02:00
Ezio Melotti 48a2f8fd97 #13054: sys.maxunicode is now always 0x10FFFF. 2011-09-29 00:18:19 +03:00
Georg Brandl fbd1e041af Merge with 3.2. 2011-09-04 08:42:26 +02:00
Victor Stinner 795eaeb41f Issue #12326: update sys.platform doc for Linux 2011-08-21 12:08:11 +02:00
Georg Brandl a47e53e42e Update sys.platform doc for #12326. 2011-09-03 09:26:09 +02:00
Antoine Pitrou 462d1b39a4 Move sys.subversion at the right place in alphabetical order, and informally deprecate it. 2011-07-09 16:02:19 +02:00
Antoine Pitrou 87fd76edb6 Issue #12326: document the recommended idiom for checking sys.platform on Unix systems.
Also, point to the various alternatives.
2011-07-09 15:55:38 +02:00
Antoine Pitrou a83cdaae89 Issue #12326: document the recommended idiom for checking sys.platform on Unix systems.
Also, point to the various alternatives.
2011-07-09 15:54:23 +02:00
Georg Brandl 93ea851e83 Merge two minor doc changes into default. 2011-05-13 07:01:58 +02:00
Georg Brandl 5166375045 Use singular they. Thanks to Mark Summerfield. 2011-05-13 06:55:28 +02:00
R David Murray c55a7ea2b8 Merge #11901: post-commit review fixes per Georg Brandl 2011-04-30 16:36:37 -04:00
R David Murray b751d6195f Merge #11901: post-commit review fixes per Georg Brandl 2011-04-30 16:36:08 -04:00
R David Murray 9beb34ee0d #11901: post-commit review fixes per Georg Brandl 2011-04-30 16:35:29 -04:00
Victor Stinner d5c355ccc7 Issue #11223: Replace threading._info() by sys.thread_info 2011-04-30 14:53:09 +02:00
Éric Araujo 0abb8b74d9 Merge 3.2 2011-04-27 16:32:36 +02:00
Éric Araujo 7fb624fe51 Branch merge 2011-04-27 16:28:50 +02:00
Éric Araujo 944d16c6c4 Merge 3.1 2011-04-27 16:27:38 +02:00
Éric Araujo 9a42793761 Branch merge 2011-04-27 16:23:56 +02:00
Éric Araujo 10f3d7acbd Change markup so it generates a link 2011-04-27 16:22:32 +02:00
R David Murray dff18b0858 Merge #11901: add description of how bitfields are laid out to hexversion docs
Patch by Sijin Joseph.
2011-04-25 16:14:26 -04:00
R David Murray 0fb5b398cd Merge #11901: add description of how bitfields are laid out to hexversion docs
Patch by Sijin Joseph.
2011-04-25 16:13:54 -04:00
R David Murray 2043f9c582 #11901: add description of how bitfields are laid out to hexversion docs
Patch by Sijin Joseph.
2011-04-25 16:12:26 -04:00
Éric Araujo 3e8987025f Add versionchanged for c19752ea037f (#10998) 2011-04-24 04:37:00 +02:00
Benjamin Peterson 2b8ef2df57 say struct sequence rather than structseq and link to glossary 2011-04-20 18:31:22 -05:00
Éric Araujo b3a591bf06 Branch merge 2011-03-26 02:01:33 +01:00
Éric Araujo 5c1da90f8c Merge 3.2 2011-03-26 02:00:51 +01:00
Éric Araujo 722bec4210 Merge 3.1 2011-03-26 01:59:47 +01:00
Éric Araujo be3bd57ba2 Remove traces of division_warning left over from Python 2 (#10998) 2011-03-26 01:55:15 +01:00
Éric Araujo 5ab477695c 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 00:47:04 +01:00
Georg Brandl 776e586114 Remove sys.subversion and svn build identification leftovers. 2011-03-06 10:35:42 +01:00
Georg Brandl 375aec2315 Fix a few doc errors, mostly undefined keywords. 2011-01-15 17:03:02 +00:00
Georg Brandl 8aa7e999b5 Add sys.flags.quiet attribute for the new -q option, as noted missing by Eric in #1772833. 2010-12-28 18:30:18 +00:00
Raymond Hettinger c539a2a88e Add link to a sample solution to a common problem. 2010-12-17 23:31:30 +00:00
Éric Araujo 3efdf0630b Merged revisions 86521,86632,86823-86824,87294,87296,87300,87302 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r86521 | eric.araujo | 2010-11-18 17:38:46 +0100 (jeu., 18 nov. 2010) | 17 lines

  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 ````.

  For modules which do have a command-line interface, lists of options
  have been properly marked up with the program/cmdoption directives
  combo.  Options defined in such blocks can be linked to with :option:
  later in the same file, they won’t link to an option of python.

  Finally, the markup of command-line fragments in optparse.rst has
  been cleaned to use ``x`` instead of ``"x"``, keeping that latter
  form for actual Python strings.

  Patch by Eli Bendersky and Éric Araujo.
........
  r86632 | eric.araujo | 2010-11-21 04:09:17 +0100 (dim., 21 nov. 2010) | 2 lines

  Style edits in followup to r86521 (#9312)
........
  r86823 | eric.araujo | 2010-11-27 00:31:07 +0100 (sam., 27 nov. 2010) | 2 lines

  Use link-generating markup (see #9312)
........
  r86824 | eric.araujo | 2010-11-27 00:46:18 +0100 (sam., 27 nov. 2010) | 2 lines

  Rewrap long lines + minor edits
........
  r87294 | eric.araujo | 2010-12-16 01:07:01 +0100 (jeu., 16 déc. 2010) | 2 lines

  No need to generate a link for something that’s just above.
........
  r87296 | eric.araujo | 2010-12-16 01:23:30 +0100 (jeu., 16 déc. 2010) | 2 lines

  Advertise “python -m” instead of direct filename.
........
  r87300 | eric.araujo | 2010-12-16 02:40:26 +0100 (jeu., 16 déc. 2010) | 2 lines

  Advertise “python -m test” over test.regrtest (r87296 followup)
........
  r87302 | eric.araujo | 2010-12-16 03:10:11 +0100 (jeu., 16 déc. 2010) | 2 lines

  Add versionadded directive missing from r78983.
........
2010-12-16 03:16:29 +00:00
Victor Stinner 13d49ee7d6 Issue #10601: sys.displayhook uses 'backslashreplace' error handler on
UnicodeEncodeError.
2010-12-04 17:24:33 +00:00
Georg Brandl ab32fec83c Merged revisions 85572-85573,85606,85609-85622,85624,85626-85627,85629,85631,85633,85635-85636,85638-85639,85641-85642 via svnmerge from
svn+ssh://svn.python.org/python/branches/py3k

........
  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.
........
  r85613 | georg.brandl | 2010-10-17 11:43:35 +0200 (So, 17 Okt 2010) | 1 line

  Fix hmac docs: it takes and returns bytes, except for hexdigest().
........
  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.
........
  r85617 | georg.brandl | 2010-10-17 12:09:06 +0200 (So, 17 Okt 2010) | 1 line

  #5212: md5 weaknesses do not affect hmac, so remove the note about that.
........
  r85618 | georg.brandl | 2010-10-17 12:14:38 +0200 (So, 17 Okt 2010) | 1 line

  #9086: correct wrong terminology about linking with pythonXY.dll.
........
  r85619 | georg.brandl | 2010-10-17 12:15:50 +0200 (So, 17 Okt 2010) | 1 line

  Make file names consistent.
........
  r85620 | georg.brandl | 2010-10-17 12:22:28 +0200 (So, 17 Okt 2010) | 1 line

  Remove second parser module example; it referred to non-readily-available example files, and this kind of discovery is much better done with the AST nowadays anyway.
........
  r85621 | georg.brandl | 2010-10-17 12:24:54 +0200 (So, 17 Okt 2010) | 1 line

  #9105: move pickle warning to a bit more prominent location.
........
  r85622 | georg.brandl | 2010-10-17 12:28:04 +0200 (So, 17 Okt 2010) | 1 line

  #9112: document error() and exit() methods of ArgumentParser.
........
  r85624 | georg.brandl | 2010-10-17 12:34:28 +0200 (So, 17 Okt 2010) | 1 line

  Some markup and style fixes in argparse docs.
........
  r85626 | georg.brandl | 2010-10-17 12:38:20 +0200 (So, 17 Okt 2010) | 1 line

  #9117: fix syntax for class definition.
........
  r85627 | georg.brandl | 2010-10-17 12:44:11 +0200 (So, 17 Okt 2010) | 1 line

  #9138: reword introduction to classes in Python.
........
  r85629 | georg.brandl | 2010-10-17 12:51:45 +0200 (So, 17 Okt 2010) | 1 line

  #5962: clarify sys.exit() vs. threads.
........
  r85631 | georg.brandl | 2010-10-17 12:53:54 +0200 (So, 17 Okt 2010) | 1 line

  Fix capitalization.
........
  r85633 | georg.brandl | 2010-10-17 12:59:41 +0200 (So, 17 Okt 2010) | 1 line

  #9204: remove mentions of removed types in the types module.
........
  r85635 | georg.brandl | 2010-10-17 13:03:22 +0200 (So, 17 Okt 2010) | 1 line

  #5121: fix claims about default values leading to segfaults.
........
  r85636 | georg.brandl | 2010-10-17 13:06:14 +0200 (So, 17 Okt 2010) | 1 line

  #9237: document sys.call_tracing().
........
  r85638 | georg.brandl | 2010-10-17 13:13:37 +0200 (So, 17 Okt 2010) | 1 line

  Port changes to pickle docs apparently lost in py3k.
........
  r85639 | georg.brandl | 2010-10-17 13:23:56 +0200 (So, 17 Okt 2010) | 1 line

  Make twisted example a bit more logical.
........
  r85641 | georg.brandl | 2010-10-17 13:29:07 +0200 (So, 17 Okt 2010) | 1 line

  Fix documentation of dis.opmap direction.
........
  r85642 | georg.brandl | 2010-10-17 13:36:28 +0200 (So, 17 Okt 2010) | 1 line

  #9730: fix example.
........
2010-11-26 08:49:15 +00:00
Georg Brandl c524cff3d3 Merged revisions 85530,85532-85534,85538-85543,85546-85548 via svnmerge from
svn+ssh://svn.python.org/python/branches/py3k

........
  r85530 | georg.brandl | 2010-10-15 17:32:05 +0200 (Fr, 15 Okt 2010) | 1 line

  Refrain from using inline suites.
........
  r85532 | georg.brandl | 2010-10-15 18:03:02 +0200 (Fr, 15 Okt 2010) | 1 line

  #7771: reference to documentation of dictview methods and operations.
........
  r85533 | georg.brandl | 2010-10-15 18:07:41 +0200 (Fr, 15 Okt 2010) | 1 line

  #9683: remove broken dead code dealing with nested arguments removed from Py3k, and update the docs and docstrings accordingly.
........
  r85534 | georg.brandl | 2010-10-15 18:19:43 +0200 (Fr, 15 Okt 2010) | 1 line

  #9801: document how list and dict proxies created by Managers behave w.r.t. mutable items.
........
  r85538 | georg.brandl | 2010-10-15 18:35:46 +0200 (Fr, 15 Okt 2010) | 1 line

  #7303: add documentation for useful pkgutil functions and classes.
........
  r85539 | georg.brandl | 2010-10-15 18:42:14 +0200 (Fr, 15 Okt 2010) | 1 line

  Fix issue references.
........
  r85540 | georg.brandl | 2010-10-15 18:42:37 +0200 (Fr, 15 Okt 2010) | 1 line

  #6798: fix wrong docs for the arguments to several trace events.
........
  r85541 | georg.brandl | 2010-10-15 18:53:24 +0200 (Fr, 15 Okt 2010) | 1 line

  #4968: updates to inspect.is* function docs.
........
  r85542 | georg.brandl | 2010-10-15 19:01:15 +0200 (Fr, 15 Okt 2010) | 1 line

  #7790: move table of struct_time members to the actual description of struct_time.
........
  r85543 | georg.brandl | 2010-10-15 19:03:02 +0200 (Fr, 15 Okt 2010) | 1 line

  #4785: document strict argument of JSONDecoder, plus add object_pairs_hook in the docstrings.
........
  r85546 | georg.brandl | 2010-10-15 19:58:45 +0200 (Fr, 15 Okt 2010) | 1 line

  #5762: fix handling of empty namespace in minidom, which would result in AttributeError on toxml().
........
  r85547 | georg.brandl | 2010-10-15 20:00:35 +0200 (Fr, 15 Okt 2010) | 1 line

  #6098: Refrain from claiming DOM level 3 conformance in minidom.
........
  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.
........
2010-11-26 08:42:45 +00:00
Éric Araujo 713d3039dc 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 ````.

For modules which do have a command-line interface, lists of options
have been properly marked up with the program/cmdoption directives
combo.  Options defined in such blocks can be linked to with :option:
later in the same file, they won’t link to an option of python.

Finally, the markup of command-line fragments in optparse.rst has
been cleaned to use ``x`` instead of ``"x"``, keeping that latter
form for actual Python strings.

Patch by Eli Bendersky and Éric Araujo.
2010-11-18 16:38:46 +00:00
Alexander Belopolsky 96d1eb1ec8 Merged revisions 85732,85778,85785,85853,85930,86008,86089 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r85732 | alexander.belopolsky | 2010-10-19 17:07:52 -0400 (Tue, 19 Oct 2010) | 3 lines

  Issue #7061: Fixed some of the issues in turtle module documentation
  reported by Terry J. Reedy.
........
  r85778 | alexander.belopolsky | 2010-10-21 14:15:39 -0400 (Thu, 21 Oct 2010) | 1 line

  Issue #7061: Fixed section title
........
  r85785 | alexander.belopolsky | 2010-10-21 18:29:36 -0400 (Thu, 21 Oct 2010) | 1 line

  Fixed a typo
........
  r85853 | alexander.belopolsky | 2010-10-26 23:06:43 -0400 (Tue, 26 Oct 2010) | 4 lines

  Issue #7061: Dropped "for Tk" from turtle module title and moved its
  doc section under frameworks.  Also fixed a couple of markup issues
  that affected TOC rendering.
........
  r85930 | alexander.belopolsky | 2010-10-29 13:16:49 -0400 (Fri, 29 Oct 2010) | 1 line

  Issue 7061: Explained 'gon'
........
  r86008 | alexander.belopolsky | 2010-10-30 20:51:11 -0400 (Sat, 30 Oct 2010) | 1 line

  Issues #7061, #10225: Fixed doctests in turtle manual
........
  r86089 | alexander.belopolsky | 2010-11-01 11:45:34 -0400 (Mon, 01 Nov 2010) | 1 line

  Issue #7061: Simplified a section title.
........
2010-11-05 01:07:35 +00:00
Alexander Belopolsky f0a0d14c28 Issue #7061: Dropped "for Tk" from turtle module title and moved its
doc section under frameworks.  Also fixed a couple of markup issues
that affected TOC rendering.
2010-10-27 03:06:43 +00:00
Antoine Pitrou 9583cac633 Issue #10089: Add support for arbitrary -X options on the command-line.
They can be retrieved through a new attribute `sys._xoptions`.
2010-10-21 13:42:28 +00:00
Georg Brandl 8527126f85 #9237: document sys.call_tracing(). 2010-10-17 11:06:14 +00:00
Georg Brandl 6f4e68d82c #5962: clarify sys.exit() vs. threads. 2010-10-17 10:51:45 +00:00
Barry Warsaw a40453df37 abiflags: alphabetize and versionadded 2010-10-16 14:17:50 +00:00
Barry Warsaw 8cf4eae522 First (uncontroversial) part of issue 9807.
* Expose the build flags to Python as sys.abiflags
* Shared library libpythonX.Y<abiflags>.so
* python-config --abiflags
* Make two distutils tests that failed with --enable-shared (even before this
  patch) succeed.
* Fix a few small style issues.
2010-10-16 01:04:07 +00:00
Georg Brandl d0b0e1d869 #6798: fix wrong docs for the arguments to several trace events. 2010-10-15 16:42:37 +00:00
Georg Brandl 60203b41b0 Migrate to Sphinx 1.0 C language constructs. 2010-10-06 10:11:56 +00:00