Commit Graph

341 Commits

Author SHA1 Message Date
Ned Deily ccb92e814d
Update FAQ to point to Infrastructure Team website. (GH-12077) 2019-02-27 17:23:34 -05:00
Andre Delfino 55e335d7d5 Remove empty Dictionaries section from programming FAQ (GH-12026) 2019-02-25 11:22:07 -05:00
Serhiy Storchaka 2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174) 2018-12-19 08:09:46 +02:00
Andre Delfino 55f41e45b4 Correct a couple of unbalanced parenthesis. (GH-10779) 2018-12-05 21:45:30 +02:00
Mathieu Dupuy 5719f275b7 Doc: Delete now useless Windows FAQ section (GH-10557) 2018-11-26 17:13:41 +01:00
Mathieu Dupuy a1c4001408 Doc: Delete "how do I emulate os.kill" section in Windows FAQ (GH-10487)
That section is a tip on how to kill process on Windows for Python prior to 2.7 and 3.2.
3.1 end of support was April 2012 and 2.6 was October 2013, so that hasn't been need for supported versions of Python for more than 5 years. Beside not being needed anymore for a long time, when I read it with the eyes of a Python profane, it makes Python looks bad, like a language from the parts with warts you need to circumvent.
Let's delete that :)
2018-11-23 15:35:07 +01:00
Julien Palard 64313478bc
bpo-32613: Update window FAQ (GH-5552) 2018-11-14 16:22:27 +01:00
Stéphane Wirtel e483f02423 bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037) 2018-10-26 12:52:11 +02:00
Stéphane Wirtel d262250d07 bpo-35032: Remove inaccessible videos from faq/Windows (GH-10004)
https://bugs.python.org/issue35032
2018-10-20 08:27:03 -07:00
Gus Goulart 4505f65ae7 bpo-34203: FAQ now recommends python 3.x over 2.x (GH-9796) 2018-10-12 12:16:43 +03:00
Andrés Delfino a378254186 closes bpo-33883: Mention type checkers in the FAQ. (GH-7760) 2018-09-10 22:12:41 -07:00
INADA Naoki c48e26dcad
bpo-27671: Update FAQ about why len is function (GH-8432) 2018-07-31 14:49:22 +09:00
Andrés Delfino 8d41278045 bpo-33888: Use CPython instead of Python in the FAQ (GH-7767)
Make the change where discussing the CPython implementation of lists and dicts.
2018-07-07 19:25:47 -04:00
Julien Palard a6e1e41e05 Update Stackless Python wiki URL (GH-8072)
It was moved from bitbucket to GitHub.
2018-07-04 21:31:38 -07:00
INADA Naoki c6cd164cff
bpo-30660: Doc: Optimize PNG files by optipng (GH-8032)
Using OptiPNG 0.7.7.
Used command is: `find . -name '*.png' | xargs optipng -o7`
2018-07-01 16:02:52 +09:00
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి) 866c168a5f bpo-33957: Doc: Use better wording (GH-7912) 2018-06-26 17:27:05 +09:00
Andrés Delfino 38cf49bf69 bpo-33887: Add TOC to Design and History FAQ(GH-7766) 2018-06-23 11:27:16 -07:00
Noah Haasis 2707e41a5c bpo-33836: Recommend keyword-only param for memoization in FAQ (GH-7687)
Update the the signature in the code example to make `_cache` a keyword-only parameter.
2018-06-15 20:29:11 -07:00
Andrés Delfino 396ecb9c3e bpo-33799: Remove non-ordered dicts comments from FAQ 2018-06-08 15:38:07 +09:00
Stéphane Wirtel 19177fbd5d bpo-33503: Fix the broken pypi link in the source and the documentation (GH-6814) 2018-05-15 14:58:35 -04:00
Serhiy Storchaka 46936d5a71
Improve highlighting of some code blocks. (GH-6401) 2018-04-08 19:18:04 +03:00
Julien Palard 78553138be
Fix typos '.::' should typically just be '::'. (GH-6165) 2018-03-28 23:14:15 +02:00
Serhiy Storchaka 5bb0005f9f
Make formatting of some return codes conforming to the general style. (#5587) 2018-02-09 13:31:19 +02:00
Sanyam Khurana 338cd83c5d bpo-25910: Link redirections in docs (#1933)
Fixes some redirection links in docs.
2018-01-20 01:25:37 +01:00
jimmy 4f29f3c84b trivial: link updates in documentation (#2765) 2017-12-13 14:37:51 +02:00
Sanyam Khurana 1b4587a246 bpo-25910: Fixes redirection from http to https (#4674) 2017-12-06 17:39:33 +01:00
Lisa Hewus Fresh 384899dfae bpo-30737: Update DevGuide links to new URL (GH-3228)
Update old devguide links from https://docs.python.org/devguide to https://devguide.python.org
2017-08-30 09:37:43 -07:00
Gregory P. Smith e9d978fd1b Fix a typo in the Programming FAQ. (#3230)
subobjects, not subobjecs.
2017-08-28 13:43:26 -07:00
Berker Peksag d3ed2877a7 Remove outdated FOX from GUI FAQ (GH-2538)
FXpy doesn't have a Python 3 port and it only
supports Python 2.2 and older versions.

Reported by Alex Walters on docs@p.o.
2017-07-04 09:13:10 +03:00
Marco Buttu 909a6f626f bpo-27200: Fix doctests in programming.rst and datetime.rst (#401) 2017-03-18 19:59:33 +03:00
Senthil Kumaran b2ee40ed9c Change some mercurial/ hg.python.org references. (#8) 2017-02-16 07:18:42 -08:00
Victor Stinner 2b501866ed Travis CI: run rstlint.py in the docs job (#68)
Currently, http://buildbot.python.org/all/buildslaves/ware-docs
buildbot is only run as post-commit. For example, bpo-29521 (PR#41)
introduced two warnings, unnotified by the Travis CI docs job.

Modify the docs job to run toosl/rstlint.py.

Fix also the two minor warnings which causes the buildbot slave to
fail.
2017-02-13 15:30:05 +01:00
Jim DeLaHunt 3d707be950 bpo-29521 Fix two minor documentation build warnings (#41)
Much of bpo-29521 was fixed in parallel with commit 
e7ffb99 .  This cleans up the rest.

Apply parallel change to Doc/make.bat to read 
"set SPHINXOPTS=-D latex_elements.papersize="
I don't have a Windows system on which to observe the warning,
but it should be necessary.

The warning:

.../workspace/cpython_github/Doc/faq/windows.rst:303: 
    WARNING: unknown option: -t

In the Windows FAQ, `How do I keep editors from inserting tabs 
into my Python source?`, contained a reference to a Python -t
option. In Python 2.x, this caused Python to issue warnings
about lines with mixed spaces and tabs, but as of Python 3.6
it does nothing. 
 
Per discussion at http://bugs.python.org/issue29387, take
their wording. Python [3] raises an IndentationError or 
TabError. Tabnanny is now a module.
2017-02-13 08:57:13 -05:00
Berker Peksag 37023b64d7 Issue #29024: Merge from 3.5 2017-01-02 05:45:16 +03:00
Berker Peksag d2d673fc4c Issue #29024: Add Kivy entry to GUI FAQ
Patch by inclement.
2017-01-02 05:44:49 +03:00
Serhiy Storchaka c7b1a0bbe2 Issue #28763: Use double hyphens (rendered as en-dashes) in numerical ranges
in the documentation.
2016-11-26 13:43:28 +02:00
Serhiy Storchaka 0264e46caa Issue #28763: Use double hyphens (rendered as en-dashes) in numerical ranges
in the documentation.
2016-11-26 13:49:59 +02:00
Brett Cannon 78ffd6cffa Issue #28705: greatly simplify the FAQ entry on transpiling.
This also eliminats a dead link to Weave in the process.
2016-11-18 10:41:28 -08:00
Martin Panter 6a09315ff0 Issue #26462: Merge code block fixes from 3.5 2016-07-29 01:49:37 +00:00
Martin Panter 1050d2d0c7 Issue #26462: Doc: reduce literal_block warnings, fix syntax highlighting.
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
Berker Peksag f0f2960f45 Merge from 3.5 2016-06-15 18:13:12 +03:00
Berker Peksag 33e7ca78f9 Make faq/general.rst gender-inclusive, patch by Sam Hathaway. 2016-06-15 18:12:49 +03:00
Senthil Kumaran 2950776d36 [merge from 3.5] - Issue27203 - Fix doctests Doc/faq/programming.rst.
Patch contributed by Jelle Zijlstra.
2016-06-04 20:08:10 -07:00
Senthil Kumaran 7749320142 Issue27203 - Fix doctests Doc/faq/programming.rst.
Patch contributed by Jelle Zijlstra.
2016-06-04 20:07:34 -07:00
Berker Peksag 32072714fd Merge from 3.5 2016-06-01 13:55:00 -07:00
Berker Peksag 5b6a14d1cb Fix link in programming FAQ.
The example actually uses the sort method of list object.
2016-06-01 13:54:33 -07:00
Benjamin Peterson f527aa5040 merge 3.5 2016-05-26 23:19:02 -07:00
Benjamin Peterson 06198789a2 stop talking about svn 2016-05-26 23:18:51 -07:00
Benjamin Peterson f50cc9ad66 merge 3.5 2016-05-26 22:56:51 -07:00
Benjamin Peterson 047ada4ef3 remove cruft from Schwarzian transform section 2016-05-26 22:55:49 -07:00
Benjamin Peterson 3f69f02792 merge 3.5 2016-05-26 22:51:44 -07:00
Benjamin Peterson 6d3ad2f64d "Numeric Python" -> "NumPy" 2016-05-26 22:51:32 -07:00
Serhiy Storchaka c499f30286 Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 12:01:56 +03:00
Serhiy Storchaka dba903993a Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
Serhiy Storchaka 1acbf853c8 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:49:58 +03:00
Serhiy Storchaka 6dff0205b7 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:49:07 +03:00
Serhiy Storchaka 336fc5bbb0 Issue #25910: Fixed dead links in the docs. 2016-04-11 12:34:07 +03:00
Serhiy Storchaka 90be7333ea Issue #25910: Fixed dead links in the docs. 2016-04-11 12:18:56 +03:00
Georg Brandl 3902d62c4e merge with 3.5 2016-02-26 19:37:52 +01:00
Georg Brandl 5d94134040 Closes #25910: fix dead and permanently redirected links in the docs. Thanks to SilentGhost for the patch. 2016-02-26 19:37:12 +01:00
Martin Panter bc1ee460dc Issue #25179: Documentation for formatted string literals aka f-strings
Some of the inspiration and wording is taken from the text of PEP 498 by Eric
V. Smith, and the existing str.format() documentation.
2016-02-13 00:41:37 +00:00
Martin Panter d5db14794b Issue #25179: Preparatory cleanup of existing docs on string formatting
* Various sections were pointing to the section on the string.Formatter
  class, when the section on the common format string syntax is probably more
  appropriate
* Fix references to various format() functions and methods
* Nested replacement fields may contain conversions and format specifiers,
  and this is tested; see Issue #19729 for instance
2016-02-08 01:34:09 +00:00
Senthil Kumaran fcb6db50d3 merge from 3.4
Issue25917 : Fix howto links in docs. Point the reference documentation instead of wiki.
2016-01-01 23:26:53 -08:00
Senthil Kumaran d03d1d45f5 Issue25917 : Fix howto links in docs. Point the reference documentation instead of wiki. 2016-01-01 23:25:58 -08:00
Brett Cannon 762d5ea875 Issue #12484: Remove a mention of Py_InitModule() and _PyImport_FixupExtension().
Thanks to Alejandro Santos for the bug report and Anish Shah for the
patch.
2015-12-27 12:24:06 -08:00
Martin Panter 7462b64911 Issue #25523: Correct "a" article to "an" article
This changes the main documentation, doc strings, source code comments, and a
couple error messages in the test suite. In some cases the word was removed
or edited some other way to fix the grammar.
2015-11-02 03:37:02 +00:00
Benjamin Peterson b395188088 actually link to the version attributes documentation 2015-10-11 23:03:22 -07:00
Benjamin Peterson 0071b3dfcb don't mention Python 2.2 (closes #25375) 2015-10-10 23:23:55 -07:00
Serhiy Storchaka 0424eaf753 Marked keystrokes with the :kbd: role.
Fixed the case of the "Ctrl-" prefixes.
2015-09-12 17:45:25 +03:00
Martin Panter 7f02d6d0d9 Issue #23406: Clarify documentation on multiplying a sequence
Patch from Matheus Vieira Portela.
2015-09-07 02:08:55 +00:00
Robert Collins bd4dd54737 Issue #23589: Remove duplicate sentence from the FAQ. Patch by Yongzhi Pan. 2015-07-30 06:14:32 +12:00
Serhiy Storchaka 03863d2b29 Fixed documentation of functions with const char* arguments. 2015-06-21 17:11:21 +03:00
Ned Deily 72c24002b3 Issue 24304: Fix broken license link in FAQ. 2015-05-27 15:37:00 -07:00
Terry Jan Reedy d986563a06 Issue #22155: Add File Handlers subsection with createfilehandler to tkinter
doc.  Remove obsolete example from FAQ.  Patch by Martin Panter.
2015-05-17 14:49:26 -04:00
Berker Peksag 9575e1891f Issue #12955: Change the urlopen() examples to use context managers where appropriate.
Patch by Martin Panter.
2015-04-12 13:52:49 +03:00
Georg Brandl b7354a65ce Fixing broken links in doc, part 4: some more breaks and redirects 2014-10-29 10:57:37 +01:00
Georg Brandl 77fe77d4af Fixing broken links in doc, part 1: faq/ 2014-10-29 09:24:54 +01:00
Georg Brandl 5e722f698e Remove now-dead link to IDLE debugger doc and add PyCharm to the commercial IDEs. 2014-10-29 08:55:14 +01:00
Georg Brandl 485922ea1f Update "where is python.org hosted" FAQ. 2014-10-29 08:52:43 +01:00
Georg Brandl e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Georg Brandl 9205e9ebdc Closes #16155: fix a few errors in doctest output of the FAQ pages. 2014-10-06 17:51:09 +02:00
Georg Brandl a94ad1e508 Closes #10031: overhaul the "imports" section of the programming FAQ.
Remove the advice to never use relative imports; it is a leftover from 2.x implicit relative imports.
Remove the advice to locally import modules in __init__, it is a strange practice.
Remove the advice to use "from ... import *" with some modules.
2014-10-06 16:02:09 +02:00
R David Murray 12dc0d96e0 #20135: FAQ entry for list mutation. (See also 6375bf34fff6.)
I accidentally committed this in 6375bf34fff6; this changeset addresses the
last review comments on the patch.

This is a perennial question and something someone opens a ticket for probably
every other month or so, so I'm surprised we didn't already have a FAQ entry
for it.

The original patch was written by M. Votz, refined first by Ezio Melotti and
further refined by me.
2014-09-29 10:17:28 -04:00
R David Murray 623ae29469 #10510: Fix bug in forward port of 2.7 distutils patch.
Pointed out by Arfrever.
2014-09-28 11:01:11 -04:00
Berker Peksag 9c1dba2758 Revert #22251 2014-09-28 00:00:58 +03:00
Berker Peksag 3749404ba5 Issue #22251: Fix ReST markup to avoid errors building docs. 2014-09-27 23:21:35 +03:00
Benjamin Peterson 6d46dff5b5 y2k compliance, lol (closes #22380) 2014-09-10 17:13:06 -04:00
Ned Deily 29020b155a Issue #22320: Fix broken link in the General Python FAQ.
Original patch by Josh Lynn.
2014-09-01 00:06:18 -07:00
Ezio Melotti e4aad5ab32 #18034: update FAQ to suggest importlib.import_module instead of __import__. Patch by Wouter van Heyst. 2014-08-04 19:34:29 +03:00
Ezio Melotti 898eb82696 #20135: move FAQ about mutable default arguments to the programming FAQs page. 2014-07-06 20:53:27 +03:00
Eric V. Smith 04d8a245f1 Fix faq example with division. 2014-04-14 07:52:53 -04:00
Eric V. Smith fc9a4d828e Fix text about int() with octal numbers. Closes #21212. 2014-04-14 07:41:52 -04:00
Ned Deily ecd9e8ac67 Remove references to the obsolete Mac Carbon modules in the GUI
section of the FAQ.
2014-04-12 09:32:04 -07:00
Zachary Ware 2f31b4b577 Fix typos in Doc/faq/extending. Found by cocoatomo on docs@. 2014-03-20 10:16:09 -05:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Benjamin Peterson ce8d153b02 merge 3.3 2014-01-25 13:27:53 -05:00
Benjamin Peterson 714d7ffd0d update sphinx url 2014-01-25 13:27:06 -05:00
Benjamin Peterson 039a02c64e linkify 2014-01-25 13:26:18 -05:00
Benjamin Peterson e4e7199c50 merge 3.3 2014-01-25 00:00:28 -05:00
Benjamin Peterson f580d5b6f7 update hosting faq 2014-01-24 23:59:57 -05:00
Zachary Ware 77007344d9 Issue #20266: Merge with 3.3 2014-01-17 09:00:36 -06:00
Zachary Ware 9fc0e9955d Issue #20266: Update parts of the Windows FAQ 2014-01-17 08:59:44 -06:00
Serhiy Storchaka f47036c130 Removed spaces before colons and semicolons. 2013-12-24 11:04:36 +02:00
Serhiy Storchaka 89e84e7523 Removed spaces before colons and semicolons. 2013-12-24 11:05:24 +02:00
Serhiy Storchaka 2a6145290b Removed spaces before commas and periods. 2013-12-23 18:21:57 +02:00
Serhiy Storchaka a4d170d985 Removed spaces before commas and periods. 2013-12-23 18:20:51 +02:00
R David Murray 18701160cc Merge: #18036: update .pyc FAQ entry in light of PEP 3147. 2013-12-13 12:30:29 -05:00
R David Murray d913d9d54e #18036: update .pyc FAQ entry in light of PEP 3147.
Initial patch by Phil Connell.
2013-12-13 12:29:29 -05:00
Benjamin Peterson 5143ce5a01 merge 3.3 (#19805) 2013-11-26 23:05:37 -06:00
Benjamin Peterson b152e177ef recommend OrderedDict for this FAQ (closes #19805) 2013-11-26 23:05:25 -06:00
Serhiy Storchaka 98b28fddd8 Issue #18758: Fixed and improved cross-references. 2013-10-13 23:12:09 +03:00
Serhiy Storchaka bfdcd436f0 Issue #18758: Fixed and improved cross-references. 2013-10-13 23:09:14 +03:00
Georg Brandl 42840f017d merge with 3.3 2013-10-12 18:15:21 +02:00
Georg Brandl d8ede4fddd Closes #13203: add a FAQ section about seemingly duplicate id()s. 2013-10-12 18:14:25 +02:00
Georg Brandl 6930777c63 merge with 3.3 2013-10-06 10:28:48 +02:00
Georg Brandl 242e6a0bce Use "lambda expression" as preferred to "lambda form". 2013-10-06 10:28:39 +02:00
R David Murray 2f72aed1b4 Merge: Tweak programming faq examples so that it (mostly) passes doctest. 2013-06-19 16:59:22 -04:00
R David Murray fdf9503038 Tweak programming faq examples so that it (mostly) passes doctest.
The exception is the import related questions at the end, which
need to be rewritten anyway.
2013-06-19 16:58:26 -04:00
Brett Cannon 4f422e3414 Issue #17177: Update the programming FAQ to use importlib 2013-06-14 22:49:00 -04:00
Ezio Melotti 7dc4c03344 #18126: merge with 3.3. 2013-06-09 01:05:16 +03:00
Ezio Melotti c1f5839412 #18126: update NumPy links in the documentation. Patch by Yury V. Zaytsev. 2013-06-09 01:04:21 +03:00
R David Murray 95ae99205e #17973: fix technical inaccuracy in faq entry (it now passes doctest). 2013-05-21 11:44:41 -04:00
R David Murray bcf06d364d #17973: Add FAQ entry for ([],)[0] += [1] both extending and raising.
This has come up often enough now on the tracker that it deserves a FAQ entry.
2013-05-20 10:32:46 -04:00
R David Murray b3a579223e merge #17973: fix technical inaccuracy in faq entry (it now passes doctest). 2013-05-21 11:45:09 -04:00
R David Murray 63f72908a1 Merge #17973: Add FAQ entry for ([],)[0] += [1] both extending and raising. 2013-05-20 10:33:27 -04:00
Georg Brandl 9def20566a merge with 3.3 2013-04-14 10:31:24 +02:00
Georg Brandl 7b8c1324d7 Closes #17726: small clarification in design FAQ. 2013-04-14 10:31:06 +02:00
Georg Brandl 1bab7134a8 Merge with 3.3. 2013-03-28 13:28:55 +01:00
Georg Brandl 44ea77bd81 Closes #4159: add LaTeX tabular column specifications to tables that otherwise are cut off or have overlapping text. 2013-03-28 13:28:44 +01:00
Gregory P. Smith d4296fc19c cleanup references to PyString_ APIs in the 3.x docs. 2013-03-22 13:49:53 -07:00
Gregory P. Smith bcd2aa6d06 cleanup references to PyString_ APIs from 2.x in the 3.3 docs. 2013-03-22 13:49:26 -07:00
Gregory P. Smith 4b52ae8f97 Clean up references to the no longer existing PyString_ APIs in our docs. 2013-03-22 13:43:30 -07:00
Ezio Melotti a2f959169a #16862: merge with 3.3. 2013-01-05 07:38:52 +02:00
Ezio Melotti 9f6a239cf1 #16862: merge with 3.2. 2013-01-05 07:38:37 +02:00
Ezio Melotti 7449231eca #16862: remove outdated statements about Stackless. 2013-01-05 07:37:47 +02:00
Ezio Melotti 9beeefbb45 Cleanup a few minor things. 2013-01-05 07:36:54 +02:00
Ezio Melotti 0ae3525e85 Merge example fix with 3.3. 2013-01-05 06:54:38 +02:00
Ezio Melotti 87b83dd18c Merge example fix with 3.2. 2013-01-05 06:54:23 +02:00
Ezio Melotti 19cdee891e Fix example by making the exception inherit from Exception. 2013-01-05 06:53:27 +02:00
Ezio Melotti d05d3cc4eb #13094: merge with 3.3. 2013-01-05 00:51:40 +02:00
Ezio Melotti 7d48669085 #13094: merge with 3.2. 2013-01-05 00:51:20 +02:00
Ezio Melotti cad8b0ff8e #13094: add Programming FAQ entry about the behavior of closures. 2013-01-05 00:50:46 +02:00
Chris Jerdonek c475278a94 Merge from 3.3: add links and index entries for "argument" and "parameter."
This adds to the work done for issue #15990 (i.e. f44b8d69e5fc and the
commits referenced there).
2012-12-25 14:59:46 -08:00
Chris Jerdonek 32bbc1c396 Merge from 3.2: add links and index entries for "argument" and "parameter."
This adds to the work done for issue #15990 (i.e. f44b8d69e5fc and the
commits referenced there).
2012-12-25 14:57:54 -08:00
Chris Jerdonek b43099464a Add additional links and index entries for "argument" and "parameter".
This adds to the work done for issue #15990 (i.e. f44b8d69e5fc and the
commits referenced there).
2012-12-25 14:54:44 -08:00
Andrew Svetlov 8a045cb93b Add versionchanged tag to faq (useless btw because changed text is commented out) 2012-12-19 13:45:30 +02:00
Andrew Svetlov 5f11a00056 Mention OSError instead of IOError in the docs. 2012-12-18 23:16:44 +02:00
Brian Curtin 08133c2e8e Merge 3.2 2012-12-17 00:04:30 -06:00
Brian Curtin 655b0c462f Fix #14901. Update the Windows FAQ.
Patch by Ashish Nitin Patil.
2012-12-16 23:58:09 -06:00
Chris Jerdonek d97c71feda Merge from 3.2: improve argument/parameter documentation (issue #15990). 2012-11-28 02:37:42 -08:00