summaryrefslogtreecommitdiffstats
path: root/Doc/library/string.rst
Commit message (Collapse)AuthorAgeFilesLines
* [3.9] Corrections to format precision description. (GH-31291) (GH-31321)John Belmonte2022-02-141-5/+6
| | | | | | | | | | | | | | * `precision` field is a decimal integer * clarify that stated limitations are on presentation type rather than input value type. Especially misleading is "precision is not allowed for integer values", since integer value input to a format like `.1f` is fine. * regarding max field size, replace "non-number" with "string", which is the only non-numeric presentation type Automerge-Triggered-By: GH:ericvsmith. (cherry picked from commit 1d6ce67c29aa2166ef326952cb605b908fb4f987) Co-authored-by: John Belmonte <john@neggie.net>
* docs: clearly document that ":GH-X" string formatting results in "0X..." ↵Miss Islington (bot)2021-05-061-2/+4
| | | | | | | | | | (GH-25941) * clearly document that ":GH-X" string formatting results in "0X..." * put back the "serial comma" (cherry picked from commit 92ceb1c8402422412fcbb98ca19448677c667c3c) Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com>
* bpo-31907: [doc] clarify that str.format() does not support arbitrary ↵Miss Islington (bot)2021-03-281-2/+2
| | | | | | | | | expressions (GH-25053) (GH-25055) (cherry picked from commit fb1d01b9630b5069fe975f16e07a027d90b89434) Co-authored-by: Irit Katriel <iritkatriel@yahoo.com> Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>
* bpo-39096: Format specification documentation fixes for numeric types (GH-23575)Miss Islington (bot)2020-12-181-12/+23
| | | | | (cherry picked from commit 886b2e5c7a2caf87070728dba8f18c3d65e51071) Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
* bpo-39096: Improve description of 'e', 'f' and 'g' presentation types ↵Miss Islington (bot)2020-11-291-12/+31
| | | | | | | | | | | | | | | | | | (GH-23537) (GH-23550) * Improve description of 'e', 'f' and 'g' presentation types * Drop the 'E' from Scientific 'E' notation; remove >= 0 qualifications * Fix false statement that the alternate form is valid for Decimal * Nitpick: remove the Harvard/Oxford comma * Add note that the decimal point is also removed if no digits follow it, except in alternate form (cherry picked from commit c642374b3ef72f6f300616f07aea2a3f9ed83e51) Co-authored-by: Mark Dickinson <mdickinson@enthought.com> Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
* bpo-41762: Fix usage of productionlist markup in the doc (GH-22281)Miss Islington (bot)2020-09-181-2/+2
| | | | | | | | | | Use an unique identifier for the different grammars documented using the Sphinx productionlist markup. productionlist markups of the same grammar, like "expressions" or "compound statements", use the same identifier "python-grammar". (cherry picked from commit 8af239eacfcf52e4e0e2b0223e7cea4672309483) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.9] bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) (GH-21901)Victor Stinner2020-08-191-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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)
* bpo-13790: Change 'string' to 'specification' in format doc (GH-18690)Terry Jan Reedy2020-02-281-2/+2
|
* bpo-38657: Clarify numeric padding behaviour in string formatting (GH-17036)Pete Wicken2020-02-211-2/+3
| | | | | | | | | | | Make the definition of the width more explicit that it includes any extra signs added by other options. https://bugs.python.org/issue38657 Automerge-Triggered-By: @Mariatta
* bpo-32790: Add info about alt format using # for 'g' in chart (GH-6624)bchhabra24902019-09-131-1/+2
|
* bpo-23460: Fix documentation for decimal string :g formatting (GH-11850)Brennan D Baraban2019-09-111-3/+4
|
* bpo-36168: Lowercase the word "subsequent" in get_value doc (GH-14485)Krishna Oza2019-07-011-1/+1
| | | | | Subsequent -> subsequent https://bugs.python.org/issue36168
* bpo-37116: Use PEP 570 syntax for positional-only parameters. (GH-13700)Serhiy Storchaka2019-06-011-3/+3
|
* Document actual string.punctuation value. (GH-12270)Andre Delfino2019-03-141-2/+1
|
* Correct grammar mistakes in string.rst. (GH-9752)Andrés Delfino2018-11-071-2/+2
|
* bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231)Serhiy Storchaka2018-10-311-4/+4
|
* bpo-35054: Add yet more index entries for symbols. (GH-10121)Serhiy Storchaka2018-10-281-17/+15
|
* bpo-35054: Add more index entries for symbols. (GH-10064)Serhiy Storchaka2018-10-261-0/+28
|
* bpo-34273: Change 'Fixed point' to 'Fixed-point notation'. (#8673)Terry Jan Reedy2018-08-061-4/+4
| | | | | | | | | | | | | | | * bpo-34273: Change 'Fixed point' to 'Fixed-point notation'. The change in the mini language floating point and decimal table is consistent with 'Exponential notation' and clarifies that we are referring to the output notation, not an object type. * Update string.rst * Update string.rst * Update string.rst * Update string.rst
* bpo-33828: Add missing versionchanged note for string.Formatter. (GH-7668)Xiang Zhang2018-06-131-2/+5
| | | | | string.Formatter auto-numbering feature was added in 3.4 and there is no versionchanged note in its documentation, making the documentation ambiguous about which version the feature is available.
* bpo-32720: Fixed the replacement field grammar documentation. (GH-5544)Mariatta2018-02-051-2/+2
| | | | `arg_name` and `element_index` are defined as `digit`+ instead of `integer`.
* bpo-32720: Fixed the definition for width and precision in format ↵nathankerr962018-02-041-2/+2
| | | | | mini-language doc (GH-5482) Changed the definition of width and precision from "integer" to "digit+" in format mini-language doc.
* bpo-31672: Restore the former behavior when override flags in Template. (#5099)Serhiy Storchaka2018-01-041-7/+2
| | | | Overriding flags to 0 will make the default pattern matching only lower case letters.
* bpo-31672 - Add one last minor clarification for idpattern (#4483)Barry Warsaw2017-11-211-2/+4
| | | Add one last minor clarification for idpattern
* bpo-31672: doc: Remove one sentence from library/string.rst (GH-3990)INADA Naoki2017-10-141-1/+1
| | | | This sentence is removed while backporting to 3.6 branch. See https://github.com/python/cpython/pull/3982#discussion_r144555768
* bpo-31672: Fix string.Template accidentally matched non-ASCII identifiers ↵INADA Naoki2017-10-131-2/+11
| | | | | | | | | | | (GH-3872) Pattern `[a-z]` with `IGNORECASE` flag can match to some non-ASCII characters. Straightforward solution for this is using `IGNORECASE | ASCII` flag. But users may subclass `Template` and override only `idpattern`. So we want to avoid changing `Template.flags`. So this commit uses local flag `-i` for `idpattern` and change `[a-z]` to `[a-zA-Z]`.
* bpo-1198569: Allow string.Template braced pattern to be different (#3288)Barry Warsaw2017-09-041-3/+15
| | | | | | | | * bpo-1198569: Allow the braced pattern to be different ``string.Template`` subclasses can optionally define ``braceidpattern`` if they want to specify different placeholder patterns inside and outside the braces. If None (the default) it falls back to ``idpattern``.
* Improve the documentation for template strings (#856)Barry Warsaw2017-03-281-11/+19
| | | | | bpo-19824 bpo-20314 bpo-12518
* Issue #29193: A format string argument for string.Formatter.format()Serhiy Storchaka2017-01-131-3/+3
| | | | is now positional-only.
* Issue #19795: Mark up None as literal text.Serhiy Storchaka2016-10-191-1/+1
|\
| * Issue #19795: Mark up None as literal text.Serhiy Storchaka2016-10-191-1/+1
| |
* | Further improved ',' and '_' specification in format mini-language.Eric V. Smith2016-09-101-2/+2
| |
* | Improved ',' and '_' specification in format mini-language.Eric V. Smith2016-09-101-1/+2
| |
* | Issue 27080: PEP 515: add '_' formatting option.Eric V. Smith2016-09-101-1/+11
| |
* | Issue #23921: Standardized documentation whitespace formatting.Serhiy Storchaka2016-05-101-6/+6
|\ \ | |/ | | | | Original patch by James Edwards.
| * Issue #23921: Standardized documentation whitespace formatting.Serhiy Storchaka2016-05-101-6/+6
| | | | | | | | Original patch by James Edwards.
* | Merge with 3.5Terry Jan Reedy2016-03-211-2/+4
|\ \ | |/
| * Issue #15660: Further clarify 0 prefix for width specifier in formats.Terry Jan Reedy2016-03-211-2/+4
| |
* | Issue #25179: Documentation for formatted string literals aka f-stringsMartin Panter2016-02-131-3/+7
|/ | | | | Some of the inspiration and wording is taken from the text of PEP 498 by Eric V. Smith, and the existing str.format() documentation.
* Issue #25179: Preparatory cleanup of existing docs on string formattingMartin Panter2016-02-081-12/+15
| | | | | | | | | * 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
* - Issue #24351: Clarify what is meant by "identifier" in the context ofBarry Warsaw2015-06-091-6/+8
|\ | | | | | | string.Template instances.
| * - Issue #24351: Clarify what is meant by "identifier" in the context ofBarry Warsaw2015-06-091-6/+8
| | | | | | | | string.Template instances.
* | Issue #23671: string.Template now allows to specify the "self" parameter asSerhiy Storchaka2015-03-241-0/+4
|/ | | | | keyword argument. string.Formatter now allows to specify the "self" and the "format_string" parameters as keyword arguments.
* Issue #22546: update doc for mini-language float None presentation type.Terry Jan Reedy2014-10-061-4/+6
|
* #19238: fix typo in documentation.Ezio Melotti2013-11-171-1/+1
|
* #19238, #19289: fix description of the align and fill values of the format ↵Ezio Melotti2013-10-201-6/+6
| | | | specification.
* Issue #17728: Specify default precision for float.format for presentation ↵Eric V. Smith2013-04-151-2/+3
| | | | types e, f, and g.
* #17265: merge with 3.2.Ezio Melotti2013-02-211-3/+3
|\
| * #17265: fix highlight in template example. Initial patch by Berker Peksag.Ezio Melotti2013-02-211-3/+3
| |
* | #16154: merge with 3.2.Ezio Melotti2013-01-111-2/+2
|\ \ | |/