sblondon
924a3bfa28
gh-93573: Replace wrong example domains in configparser doc (GH-93574)
...
* Replace bitbucket.org domain by forge.example
* Update example to python.org
* Use explicitly invalid domain
topsecret.server.com domain is not controled by PSF. It's replaced by invalid topsecret.server.example domain. It follows RFC 2606, which advise .example as TLD for documentation.
2023-02-16 16:13:21 +01:00
Philipp A
5e74bad93c
gh-98644: point people to tomllib from configparser’s docs ( #98645 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-10-26 07:06:20 -07:00
Gregory P. Smith
296e4efebb
gh-89336: Remove configparser APIs that were deprecated for 3.12 ( #92503 )
...
https://github.com/python/cpython/issue/89336 : Remove configparser 3.12 deprecations.
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-06-21 14:31:25 -07:00
Julien Palard
3ac4e783e0
[doc] configparser: avoid inline comments. (GH-31247)
...
People are testing those blocs with the default
inline_comment_prefixes of None, leading to a:
configparser.InterpolationSyntaxError: '$' must be followed by '$' or '{', found: '$ sign ($ is the only character that needs to be escaped)'
2022-03-23 09:35:33 +01:00
vidhya
bba8008f99
bpo-20923 : [doc] Explain ConfigParser 'valid section name' and .SECTCRE (GH-31413)
2022-02-22 18:06:41 +00:00
Hugo van Kemenade
e8659b47de
bpo-45173: Keep configparser deprecations until Python 3.12 (GH-30952)
...
* Revert "bpo-45173 Remove configparser deprecations"
This reverts commit df2284bc41
.
* bpo-45173: Note these configparser deprecations will be removed in 3.12
2022-02-02 08:59:39 -08:00
Nikita Sobolev
cb07838ab7
bpo-45217: adds note that `allow_no_value` in `configparser` is optional (GH-28396)
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-09-17 12:55:51 +02:00
Hugo van Kemenade
1fc41ae870
bpo-45173 Remove configparser deprecations (GH-28292)
...
In the configparser module, these have been deprecated since Python 3.2:
* the SafeConfigParser class,
* the filename property of the ParsingError class,
* the readfp method of the ConfigParser class,
2021-09-13 19:12:36 +02:00
Kevin Follstad
48a5aa7f12
bpo-44514: Add doctest testcleanup for configparser and bz2 ( #26909 )
...
Add testcleanup section to configparser and bz2 documentation which
removes temporary files created in the filesystem when 'make doctest'
is run.
2021-07-13 15:57:05 +02:00
Jürgen Gmach
02ee819126
bpo-41963: document that ConfigParser strips off comments (GH-26197)
...
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Laura Gutierrez Funderburk <58710704+lgfunderburk@users.noreply.github.com>
2021-05-18 18:11:23 +02:00
sblondon
48b0b1b121
bpo-37779 : Add information about the overriding behavior of ConfigParser.read (GH-15177)
...
Co-Authored-By: Kyle Stanley <aeros167@gmail.com>
Co-Authored-By: Paul Ganssle <p.ganssle@gmail.com>
2020-09-23 14:28:58 +02:00
Victor Stinner
d3ded08048
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
2020-08-13 21:41:54 +02:00
Arun Persaud
9a94093189
bpo-21018: added missing documentation about escaping characters for configparser (GH-6137)
...
Document how $ and % can be escaped in configparser.
2019-09-10 14:51:09 +02:00
Inada Naoki
04694a306b
bpo-35838: document optionxform must be idempotent (GH-12656)
2019-04-02 18:08:46 +09:00
Inada Naoki
0897e0c597
bpo-33504: fix wrong "versionchanged" (GH-11712)
2019-01-31 17:53:48 +09:00
Serhiy Storchaka
913876d824
bpo-35054: Add yet more index entries for symbols. (GH-10121)
2018-10-28 13:41:26 +02: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
Serhiy Storchaka
ddb961d2ab
bpo-35054: Add more index entries for symbols. (GH-10064)
2018-10-26 09:00:49 +03:00
Ned Batchelder
890423f796
configparser doc: Properly label ConfigParser attributes (GH-9930)
2018-10-25 01:47:01 +02:00
Zackery Spytz
e45473e3ca
bpo-27351: Fix ConfigParser.read() documentation and docstring (GH-8123)
...
Switch "list" with "iterable" to match with the implementation.
2018-09-29 10:15:55 -06:00
Andrés Delfino
4acc140f8d
Fix indendation level of versionchanged directive in configparser.items() doc (GH-7543)
2018-06-08 17:20:05 -07:00
Andrés Delfino
3b0b90c8c3
bpo-33800: Fix default argument for parameter dict_type of ConfigParser/RawConfigParser (GH-7494)
2018-06-08 15:19:21 -04:00
John Reese
3a5b0d8988
bpo-33504: Migrate configparser from OrderedDict to dict. ( #6819 )
...
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.
2018-06-05 16:31:33 -07:00
Chris Bradbury
e500839796
bpo-33251: Update documentation to reflect change. (GH-6446) ( #6583 )
2018-04-23 13:56:39 -07:00
Łukasz Langa
a00d440edb
Revert 725476222a
( #6494 )
...
This note in documentation was never true.
2018-04-16 20:00:31 -07:00
Vincent Michel
e314853d57
bpo-31307: Make ConfigParser.read() accept bytes objects (GH-3420)
2017-11-02 15:47:04 +03:00
Łukasz Langa
a5fab17fc1
bpo-23835: Restore legacy defaults= behavior for RawConfigParser ( #3191 )
...
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.
2017-08-24 09:43:53 -07:00
Łukasz Langa
ea57923e89
bpo-23835: [docs] configparser converts defaults to strings ( #3176 )
...
Title says all.
2017-08-21 16:23:38 -07:00
Alex Jordan
01fa9ae546
Correct typo in configparser.rst ( #1012 )
2017-04-05 22:21:30 -04:00
David Ellis
85b8d01c91
bpo-29623: Make PathLike objects work with ConfigParser.read() ( #242 )
2017-03-03 20:14:27 +03:00
Marco Buttu
b2a7c2f986
bpo-27200: fix configparser, copyreg and ctypes doctests ( #240 )
2017-03-02 14:02:43 +03:00
Martin Panter
1f10671fc8
Issue #11670 : readfp(fp) parameter name is different to read_file(f)
2017-01-29 23:33:27 +00:00
Jesus Cea
647680ec2c
Docs: Correctly link to the methods
2016-09-20 00:01:53 +02:00
Martin Panter
eb9957065a
Issue #27626 : Spelling fixes in docs, comments and internal names
...
Based on patch by Ville Skyttä.
2016-07-28 01:11:04 +00:00
Terry Jan Reedy
fa089b9b0b
Issue #22558 : Add remaining doc links to source code for Python-coded modules.
...
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Serhiy Storchaka
dba903993a
Issue #23921 : Standardized documentation whitespace formatting.
...
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
Łukasz Langa
dfdd2f7ef8
Closes #18159 : ConfigParser getters not available on SectionProxy
2014-09-15 02:08:41 -07:00
Łukasz Langa
34cea14f74
Fix full-stop whitespace in configparser docs
2014-09-14 23:37:03 -07:00
Donald Stufft
8b852f111e
Fix Issue #21528 - Fix documentation typos
2014-05-20 12:58:38 -04:00
Andrew Kuchling
2e3743cd30
#13437 : link to the source code for a few more modules
2014-03-19 16:23:01 -04:00
Serhiy Storchaka
bfdcd436f0
Issue #18758 : Fixed and improved cross-references.
2013-10-13 23:09:14 +03:00
Ned Deily
0995c47891
Issue #18452 : fix several "occurrence" typos (reported by Févry Thibault).
2013-07-14 12:43:16 -07:00
Łukasz Langa
3a8479a583
Fixes `parser.clean()` reported in issue #16820 .
2012-12-31 03:38:39 +01:00
R David Murray
1a1883d566
#16085 : Don't promote shadowing builtins in the configparser example.
2012-09-29 14:40:23 -04:00
Ezio Melotti
e0add76468
#15831 : document multiple signatures on different lines. Patch by Chris Jerdonek.
2012-09-14 06:32:35 +03:00
Ezio Melotti
e927e25637
#15865 : add "*" in the signature to document keyword-only args in the docs. Patch by Chris Jerdonek.
2012-09-08 20:46:01 +03:00
Łukasz Langa
7335e6f3e8
removed misleading editing leftovers
2011-09-02 23:17:39 +02:00
Éric Araujo
941afedd74
Avoid using the default reST role. Makes Doc/tools/rstlint.py happy.
2011-09-01 02:47:34 +02:00
Łukasz Langa
cda41d3bf7
Actually print out the description of what changed.
2011-05-10 15:25:41 +02:00
Łukasz Langa
725476222a
Closes #12036 : ConfigParser: Document items() added the vars dictionary to the result
2011-05-09 18:49:42 +02:00