summaryrefslogtreecommitdiffstats
path: root/Doc/library/configparser.rst
Commit message (Collapse)AuthorAgeFilesLines
* bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) (GH-21901) (GH-21928)Victor Stinner2020-08-201-80/+81
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) Enable Sphinx 3.2 "c_allow_pre_v3" option and disable the c_warn_on_allowed_pre_v3 option to make the documentation compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 423e77d6de497931585d1883805a9e3fa4096b0b) * bpo-40204: Fix Sphinx sytanx in howto/instrumentation.rst (GH-21858) Use generic '.. object::' to declare markers, rather than abusing '.. c:function::' which fails on Sphinx 3. (cherry picked from commit 43577c01a2ab49122db696e9eaec6cb31d11cc81) * bpo-40204: Fix duplicates in the documentation (GH-21857) Fix two Sphinx 3 issues: Doc/c-api/buffer.rst:304: WARNING: Duplicate C declaration, also defined in 'c-api/buffer'. Declaration is 'PyBUF_ND'. Doc/c-api/unicode.rst:1603: WARNING: Duplicate C declaration, also defined in 'c-api/unicode'. Declaration is 'PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)'. (cherry picked from commit 46d10b1237c67ff8347f533eda6a5468d098f7eb) * bpo-40204: Add :noindex: in the documentation (GH-21859) Add :noindex: to duplicated documentation to fix "duplicate object description" errors. For example, fix this Sphinx 3 issue: Doc/library/configparser.rst:1146: WARNING: duplicate object description of configparser.ConfigParser.optionxform, other instance in library/configparser, use :noindex: for one of them (cherry picked from commit d3ded080482beae578faa704b13534a62d066f9f) * bpo-40204, doc: Fix syntax of C variables (GH-21846) For example, fix the following Sphinx 3 errors: Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters Invalid C declaration: Expected identifier in nested name. [error at 5] void \*obj -----^ Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*' Invalid C declaration: Expected end of definition. [error at 8] PyObject* --------^ The modified documentation is compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 474652fe9346382dbf793f20b671eb74668bebde) * bpo-40204: Fix reference to terms in the doc (GH-21865) Sphinx 3 requires to refer to terms with the exact case. For example, fix the Sphinx 3 warning: Doc/library/pkgutil.rst:71: WARNING: term Loader not found in case sensitive match.made a reference to loader instead. (cherry picked from commit bb0b08540cc93e56f3f1bde1b39ce086d9e35fe1) * bpo-40204: Fix duplicated productionlist names in the doc (GH-21900) Sphinx 3 disallows having more than one productionlist markup with the same name. Simply remove names in this case, since names are not shown anyway. For example, fix the Sphinx 3 warning: Doc/reference/introduction.rst:96: duplicate token description of *:name, other instance in reference/expressions (cherry picked from commit 1abeda80f760134b4233608e2c288790f955b95a) (cherry picked from commit 8f88190af529543c84d5dc78f19abbfd73335cf4)
* bpo-21018: added missing documentation about escaping characters for ↵Miss Islington (bot)2019-09-101-0/+5
| | | | | | | | configparser (GH-6137) (GH-15846) Document how $ and % can be escaped in configparser. (cherry picked from commit 9a94093189417adddd6b59d6c80cc5544630c8aa) Co-authored-by: Arun Persaud <arun@nubati.net>
* bpo-35838: document optionxform must be idempotent (GH-12656)Inada Naoki2019-04-021-0/+6
|
* bpo-33504: fix wrong "versionchanged" (GH-11712)Inada Naoki2019-01-311-4/+4
|
* bpo-35054: Add yet more index entries for symbols. (GH-10121)Serhiy Storchaka2018-10-281-2/+2
|
* bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)Stéphane Wirtel2018-10-261-2/+2
|
* bpo-35054: Add more index entries for symbols. (GH-10064)Serhiy Storchaka2018-10-261-0/+4
|
* configparser doc: Properly label ConfigParser attributes (GH-9930)Ned Batchelder2018-10-241-3/+3
|
* bpo-27351: Fix ConfigParser.read() documentation and docstring (GH-8123)Zackery Spytz2018-09-291-5/+6
| | | Switch "list" with "iterable" to match with the implementation.
* Fix indendation level of versionchanged directive in configparser.items() ↵Andrés Delfino2018-06-091-4/+4
| | | | doc (GH-7543)
* bpo-33800: Fix default argument for parameter dict_type of ↵Andrés Delfino2018-06-081-2/+9
| | | | ConfigParser/RawConfigParser (GH-7494)
* bpo-33504: Migrate configparser from OrderedDict to dict. (#6819)John Reese2018-06-051-41/+9
| | | | | | With 3.7+, dictionary are ordered by design. Configparser still uses collections.OrderedDict, which is unnecessary. This updates the module to use the standard dict implementation by default, and changes the docs and tests to match.
* bpo-33251: Update documentation to reflect change. (GH-6446) (#6583)Chris Bradbury2018-04-231-0/+5
|
* Revert 725476222a3c1f2f93162d75a540e6bcdeaa36fd (#6494)Łukasz Langa2018-04-171-4/+0
| | | This note in documentation was never true.
* bpo-31307: Make ConfigParser.read() accept bytes objects (GH-3420)Vincent Michel2017-11-021-1/+5
|
* bpo-23835: Restore legacy defaults= behavior for RawConfigParser (#3191)Łukasz Langa2017-08-241-2/+4
| | | | | | | The fix for bpo-23835 fixed ConfigParser behavior in defaults= handling. Unfortunately, it caused a backwards compatibility regression with RawConfigParser objects which allow for non-string values. This commit restores the legacy behavior for RawConfigParser only.
* bpo-23835: [docs] configparser converts defaults to strings (#3176)Łukasz Langa2017-08-211-1/+5
| | | Title says all.
* Correct typo in configparser.rst (#1012)Alex Jordan2017-04-061-2/+2
|
* bpo-29623: Make PathLike objects work with ConfigParser.read() (#242)David Ellis2017-03-031-7/+13
|
* bpo-27200: fix configparser, copyreg and ctypes doctests (#240)Marco Buttu2017-03-021-12/+17
|
* Issue #11670: readfp(fp) parameter name is different to read_file(f)Martin Panter2017-01-291-6/+6
|
* Docs: Correctly link to the methodsJesus Cea2016-09-191-19/+22
|
* Issue #27626: Spelling fixes in docs, comments and internal namesMartin Panter2016-07-281-1/+1
| | | | Based on patch by Ville Skyttä.
* Issue #22558: Add remaining doc links to source code for Python-coded modules.Terry Jan Reedy2016-06-111-0/+2
| | | | | Reformat header above separator line (added if missing) to a common format. Patch by Yoni Lavi.
* Issue #23921: Standardized documentation whitespace formatting.Serhiy Storchaka2016-05-101-5/+5
| | | | Original patch by James Edwards.
* Closes #18159: ConfigParser getters not available on SectionProxyŁukasz Langa2014-09-151-11/+35
|
* Fix full-stop whitespace in configparser docsŁukasz Langa2014-09-151-42/+44
|
* Fix Issue #21528 - Fix documentation typosDonald Stufft2014-05-201-2/+2
|
* #13437: link to the source code for a few more modulesAndrew Kuchling2014-03-191-0/+2
|
* Issue #18758: Fixed and improved cross-references.Serhiy Storchaka2013-10-131-1/+2
|
* Issue #18452: fix several "occurrence" typos (reported by Févry Thibault).Ned Deily2013-07-141-1/+1
|
* Fixes `parser.clean()` reported in issue #16820.Łukasz Langa2012-12-311-1/+7
|
* #16085: Don't promote shadowing builtins in the configparser example.R David Murray2012-09-291-7/+7
|
* #15831: document multiple signatures on different lines. Patch by Chris ↵Ezio Melotti2012-09-141-1/+2
| | | | Jerdonek.
* #15865: add "*" in the signature to document keyword-only args in the docs. ↵Ezio Melotti2012-09-081-5/+11
| | | | Patch by Chris Jerdonek.
* removed misleading editing leftoversŁukasz Langa2011-09-021-4/+0
|
* Avoid using the default reST role. Makes Doc/tools/rstlint.py happy.Éric Araujo2011-09-011-3/+3
|
* Actually print out the description of what changed.Łukasz Langa2011-05-101-1/+0
|
* Closes #12036: ConfigParser: Document items() added the vars dictionary to ↵Łukasz Langa2011-05-091-0/+5
| | | | the result
* Style updates for the #11670 solution after post-commit review by Ezio Melotti:Łukasz Langa2011-04-281-23/+17
| | | | | | http://mail.python.org/pipermail/python-checkins/2011-April/104688.html Thanks!
* Fixed trailing whitespace in the ReST file.Łukasz Langa2011-04-271-3/+3
|
* Closes #11670: configparser read_file now iterates over f.Łukasz Langa2011-04-271-5/+24
|
* #11027: documented how to override SECTCREŁukasz Langa2011-01-281-0/+32
|
* 100% test coverage, better mapping protocol compatibility, some minor bugfixesŁukasz Langa2010-12-171-16/+26
|
* configparser API cleanup: default values now sensible, slightly incompatible.Łukasz Langa2010-12-171-38/+89
| | | | | Backwards compatible alternative values possible as documented. Done by Łukasz Langa, approved by Raymond and Fred.
* Broken ConfigParser removed, SafeConfigParser renamed to ConfigParser.Łukasz Langa2010-12-161-60/+39
| | | | Life is beatiful once again.
* configparser: fixed inconsistency where in SafeConfigParser option valuesŁukasz Langa2010-12-041-4/+18
| | | | | were ensured to be strings but section names and option keys were not. Behaviour unchanged for RawConfigParser and ConfigParser.
* Issue 10499: Modular interpolation in configparserŁukasz Langa2010-12-031-224/+259
|
* Let’s keep “throw” for the generator method and use “raise” elsewhere.Éric Araujo2010-11-301-1/+1
|
* Issue #10489: removed broken `__name__` support from configparserŁukasz Langa2010-11-211-6/+1
|