Commit Graph

69 Commits

Author SHA1 Message Date
Sandro Tosi c4114ead71 use diveintopython.net now that DIP.org returns 410; thanks to Josh Gachnang from docs@ 2011-10-31 17:45:09 +01:00
Éric Araujo 9bcbc62062 Update dead references from py.org/dev/faq to the devguide (#13176) 2011-10-14 18:05:56 +02:00
Éric Araujo 79c9d4faa7 Port a few markup edits from 3.x 2011-09-09 19:20:27 +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 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
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
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
Raymond Hettinger 080ad041d2 More descriptive title. 2010-09-01 22:37:17 +00:00
Georg Brandl 90c0718052 Merged revisions 82615 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r82615 | georg.brandl | 2010-07-07 00:58:50 +0200 (Mi, 07 Jul 2010) | 1 line

  Fix typo.
........
2010-07-07 19:09:12 +00:00
Ezio Melotti 9d8d2a4d7c Update whatsnew/2.7.rst, add a few links and fix a couple of XXX. Also add a paragraph about DeprecationWarnings in cmdline.rst. 2010-07-03 07:43:04 +00:00
Georg Brandl 3d0a602c35 Fix URL. 2010-06-27 10:51:44 +00:00
Nick Coghlan 8842c356aa Revert r80580 due to some unintended side effects. See issue #8202 for details. 2010-06-13 06:50:39 +00:00
Nick Coghlan ad709ee06b Add version changed note for -m tinkering with sys.argv[0] during the search process 2010-04-28 14:53:59 +00:00
Nick Coghlan c5e4485248 Issue 8202: when using the -m command line switch, sys.argv[0] is now '-m' instead of '-c' while searching for the module to be executed 2010-04-28 14:51:08 +00:00
Andrew M. Kuchling fced90835c Two grammar fixes 2010-04-11 01:39:36 +00:00
Benjamin Peterson f3a8c6675f tell people to update python.man, too 2010-04-06 23:32:27 +00:00
Philip Jenvey aebbaeb962 #7301: add the environment variable $PYTHONWARNINGS to supplement the -W
command line option
patch from Brian Curtin
2010-04-06 23:24:45 +00:00
Ezio Melotti 425aa2e11b Fix some broken URLs. 2010-04-05 12:51:45 +00:00
Barry Warsaw b1e66ee651 Resolve bug 7847 by including documentation for -J, -U, and -X under "Options
you shouldn't use".
2010-02-05 18:45:25 +00:00
Georg Brandl 96aa3ca242 #7653: clarify how the PythonPath registry key should look like. 2010-01-07 21:48:47 +00:00
Brett Cannon f31d1a0577 Add some missing command-line options to the main list. All but -V were already
documented. Left -V undocumented for now (and -U was already undocumented).
2010-01-01 01:44:57 +00:00
Ezio Melotti 062d2b52f3 #7388: "python".capitalize() in the Doc 2009-12-19 22:41:49 +00:00
Georg Brandl 6c14e587f5 Use "impl-detail" directive where applicable. 2009-10-22 11:48:10 +00:00
Georg Brandl a4314c2b21 Fix broken links found by "make linkcheck". scipy.org seems to be done right now, so I could not verify links going there. 2009-10-11 20:16:16 +00:00
Ezio Melotti 2c7b4934ad #6904 - fix broken link 2009-09-14 00:48:31 +00:00
Georg Brandl d7d4fd7336 builtin -> built-in. 2009-07-26 14:37:28 +00:00
Georg Brandl 5a85d5c4f2 #6332: fix word dupes throughout the source. 2009-06-24 06:41:19 +00:00
Georg Brandl d91f8cf779 Remove ".. warning::" markup that doesnt contain warnings for users, rather todo items. 2009-04-27 15:10:44 +00:00
Georg Brandl a0eea590c7 Add section numbering to some of the larger subdocuments. 2009-03-28 19:57:36 +00:00
Nick Coghlan d39600e69f Issue 4195: Restore the ability to execute packages with the -m switch (but this time in a way that leaves the import machinery in a valid state). (Original patch by Andi Vajda) 2009-02-08 01:26:34 +00:00
Benjamin Peterson a924289e9a fix spelling 2009-01-09 03:03:05 +00:00
Benjamin Peterson fe8076eeb6 specify what -3 warnings are about 2009-01-09 02:53:35 +00:00
Georg Brandl c62ef8b4d9 Remove trailing whitespace. 2009-01-03 20:55:06 +00:00
Georg Brandl fc29f27c16 #4811: fix markup glitches (mostly remains of the conversion),
found by Gabriel Genellina.
2009-01-02 20:25:14 +00:00
Georg Brandl 1966a237fb Markup fix. 2008-12-23 15:44:25 +00:00
Georg Brandl 14da8e800b Fix syntax. 2008-11-07 08:27:39 +00:00
Georg Brandl 73ac29e426 #3916: fixes for docs wrt. Windows directory layout 2008-09-21 07:17:00 +00:00
Georg Brandl 9af9498c6e Remove things specific to the old Macintosh, and spell "Mac OS X" consistently. 2008-09-13 17:41:16 +00:00
Georg Brandl c0f10f34b1 #3472: update Mac-bundled Python version info. 2008-09-09 20:28:31 +00:00
Benjamin Peterson 90f36730e2 fix various doc typos #3320 2008-07-12 20:16:19 +00:00
Georg Brandl d987545d30 Clarify what ":errorhandler" refers to. 2008-06-11 17:57:44 +00:00
Martin v. Löwis 99815892f6 New environment variable PYTHONIOENCODING. 2008-06-01 07:20:46 +00:00
Christian Heimes af748c3ab8 Implemented PEP 370 2008-05-06 22:41:46 +00:00
Nick Coghlan 31f631539e Update command line usage documentation to reflect 2.6 changes (also includes some minor cleanups). Addresses TODO list issue 2258 2008-04-30 14:23:36 +00:00
Georg Brandl 9c06574024 #2239: PYTHONPATH delimiter is os.pathsep. 2008-03-05 19:31:44 +00:00
Georg Brandl 3ef2063ec8 #2194: fix some typos. 2008-02-26 19:13:45 +00:00
Georg Brandl 4425e7cee7 Specify what kind of warning -3 emits. 2008-02-23 23:43:01 +00:00
Georg Brandl 21297fa621 Fix markup. 2008-01-20 21:10:08 +00:00
Georg Brandl 8d10167236 Better method for associating .py files with the interpreter. 2008-01-08 19:42:30 +00:00