Skip to content

Commit

Permalink
Misc copyedits in docs on built-in types (pythonGH-24466)
Browse files Browse the repository at this point in the history
# 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
  • Loading branch information
adorilson authored Nov 17, 2022
1 parent 12b5a3c commit a0d940d
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions Doc/library/stdtypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ Notes:
The numeric literals accepted include the digits ``0`` to ``9`` or any
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.


Expand Down Expand Up @@ -1522,7 +1522,7 @@ multiple fragments.
printable string representation of *object*. For string objects, this is
the string itself. If *object* does not have a :meth:`~object.__str__`
method, then :func:`str` falls back to returning
:meth:`repr(object) <repr>`.
:func:`repr(object) <repr>`.

.. index::
single: buffer protocol; str (built-in class)
Expand Down Expand Up @@ -1597,8 +1597,9 @@ expression support in the :mod:`re` module).
lowercase, :meth:`lower` would do nothing to ``'ß'``; :meth:`casefold`
converts it to ``"ss"``.

The casefolding algorithm is described in section 3.13 of the Unicode
Standard.
The casefolding algorithm is
`described in section 3.13 of the Unicode Standard
<http://www.unicode.org/versions/Unicode15.0.0/ch03.pdf#G53253>`__.

.. versionadded:: 3.3

Expand Down Expand Up @@ -1757,7 +1758,8 @@ expression support in the :mod:`re` module).
one character, ``False`` otherwise. Alphabetic characters are those characters defined
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
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()
Expand Down Expand Up @@ -1794,7 +1796,7 @@ expression support in the :mod:`re` module).
Return ``True`` if the string is a valid identifier according to the language
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`.

Example:
Expand Down Expand Up @@ -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
lowercase.

The lowercasing algorithm used is described in section 3.13 of the Unicode
Standard.
The lowercasing algorithm used is
`described in section 3.13 of the Unicode Standard
<https://www.unicode.org/versions/Unicode15.0.0/ch03.pdf#G34078>`__.


.. method:: str.lstrip([chars])
Expand Down Expand Up @@ -2236,8 +2239,9 @@ expression support in the :mod:`re` module).
character(s) is not "Lu" (Letter, uppercase), but e.g. "Lt" (Letter,
titlecase).

The uppercasing algorithm used is described in section 3.13 of the Unicode
Standard.
The uppercasing algorithm used is
`described in section 3.13 of the Unicode Standard
<https://www.unicode.org/versions/Unicode15.0.0/ch03.pdf#G34078>`__.


.. method:: str.zfill(width)
Expand Down

0 comments on commit a0d940d

Please sign in to comment.