mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Misc copyedits in docs on built-in types (GH-24466)

Browse source 
# DOC: Improvements in library/stdtypes

This PR does the following:

1. Replaces :meth: by :func: around repr function
2. Adds links to Unicode Standard site
3. Makes explicit "when" you can call the `iskeyword` function. The previous text could cause confusion to readers, especially those with English as a second language. The reader could understand that the `isidentifier` method calls the `iskeyword` function. Now, it is explicit that the dev can do it.
4. Replaces a URL with an inline link.

Automerge-Triggered-By: GH:AlexWaygood
This commit is contained in:
Adorilson Bezerra 2022-11-17 16:06:00 +00:00 • committed by GitHub
parent 12b5a3c5f5
commit a0d940d6ac
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

24
Doc/library/stdtypes.rst
View file

@ -353,7 +353,7 @@ Notes:
The numeric literals accepted include the digits ``0`` to ``9`` or any The numeric literals accepted include the digits ``0`` to ``9`` or any
Unicode equivalent (code points with the ``Nd`` property). Unicode equivalent (code points with the ``Nd`` property).
See https://www.unicode.org/Public/15.0.0/ucd/extracted/DerivedNumericType.txt See `the Unicode Standard <https://unicode.org/Public/UNIDATA/extracted/DerivedNumericType.txt>`_
for a complete list of code points with the ``Nd`` property. for a complete list of code points with the ``Nd`` property.
@ -1522,7 +1522,7 @@ multiple fragments.
printable string representation of *object*. For string objects, this is printable string representation of *object*. For string objects, this is
the string itself. If *object* does not have a :meth:`~object.__str__` the string itself. If *object* does not have a :meth:`~object.__str__`
method, then :func:`str` falls back to returning method, then :func:`str` falls back to returning
:meth:`repr(object) <repr>`. :func:`repr(object) <repr>`.
.. index:: .. index::
single: buffer protocol; str (built-in class) single: buffer protocol; str (built-in class)
@ -1597,8 +1597,9 @@ expression support in the :mod:`re` module).
lowercase, :meth:`lower` would do nothing to ``'ß'``; :meth:`casefold` lowercase, :meth:`lower` would do nothing to ``'ß'``; :meth:`casefold`
converts it to ``"ss"``. converts it to ``"ss"``.
The casefolding algorithm is described in section 3.13 of the Unicode The casefolding algorithm is
Standard. `described in section 3.13 of the Unicode Standard
<http://www.unicode.org/versions/Unicode15.0.0/ch03.pdf#G53253>`__.
.. versionadded:: 3.3 .. versionadded:: 3.3
@ -1757,7 +1758,8 @@ expression support in the :mod:`re` module).
one character, ``False`` otherwise. Alphabetic characters are those characters defined one character, ``False`` otherwise. Alphabetic characters are those characters defined
in the Unicode character database as "Letter", i.e., those with general category in the Unicode character database as "Letter", i.e., those with general category
property being one of "Lm", "Lt", "Lu", "Ll", or "Lo". Note that this is different property being one of "Lm", "Lt", "Lu", "Ll", or "Lo". Note that this is different
from the "Alphabetic" property defined in the Unicode Standard. from the `Alphabetic property defined in the Unicode Standard
<https://www.unicode.org/versions/Unicode15.0.0/ch04.pdf#G91002>`_.
.. method:: str.isascii() .. method:: str.isascii()
@ -1794,7 +1796,7 @@ expression support in the :mod:`re` module).
Return ``True`` if the string is a valid identifier according to the language Return ``True`` if the string is a valid identifier according to the language
definition, section :ref:`identifiers`. definition, section :ref:`identifiers`.
Call :func:`keyword.iskeyword` to test whether string ``s`` is a reserved :func:`keyword.iskeyword` can be used to test whether string ``s`` is a reserved
identifier, such as :keyword:`def` and :keyword:`class`. identifier, such as :keyword:`def` and :keyword:`class`.
Example: Example:
@ -1891,8 +1893,9 @@ expression support in the :mod:`re` module).
Return a copy of the string with all the cased characters [4]_ converted to Return a copy of the string with all the cased characters [4]_ converted to
lowercase. lowercase.
The lowercasing algorithm used is described in section 3.13 of the Unicode The lowercasing algorithm used is
Standard. `described in section 3.13 of the Unicode Standard
<https://www.unicode.org/versions/Unicode15.0.0/ch03.pdf#G34078>`__.
.. method:: str.lstrip([chars]) .. method:: str.lstrip([chars])
@ -2236,8 +2239,9 @@ expression support in the :mod:`re` module).
character(s) is not "Lu" (Letter, uppercase), but e.g. "Lt" (Letter, character(s) is not "Lu" (Letter, uppercase), but e.g. "Lt" (Letter,
titlecase). titlecase).
The uppercasing algorithm used is described in section 3.13 of the Unicode The uppercasing algorithm used is
Standard. `described in section 3.13 of the Unicode Standard
<https://www.unicode.org/versions/Unicode15.0.0/ch03.pdf#G34078>`__.
.. method:: str.zfill(width) .. method:: str.zfill(width)