diff options
| author | Maciej Olko <maciej.olko@affirm.com> | 2023-09-29 08:27:43 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-29 08:27:43 (GMT) |
| commit | 8898a8683b5631c24d51a6a7babf55a255874950 (patch) | |
| tree | 8382dc1d85e79625d471751dfb15f9e3b1e96be8 /Doc | |
| parent | f1b1680a72cc7eb650f785b9438a3900ca6f695e (diff) | |
| download | cpython-8898a8683b5631c24d51a6a7babf55a255874950.zip cpython-8898a8683b5631c24d51a6a7babf55a255874950.tar.gz cpython-8898a8683b5631c24d51a6a7babf55a255874950.tar.bz2 | |
gh-101100: Fix Sphinx warnings in `tutorial/controlflow.rst` (#109424)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/tools/.nitignore | 1 | ||||
| -rw-r--r-- | Doc/tutorial/controlflow.rst | 4 |
2 files changed, 2 insertions, 3 deletions
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore index e6ababf..f217da9 100644 --- a/Doc/tools/.nitignore +++ b/Doc/tools/.nitignore @@ -146,7 +146,6 @@ Doc/reference/datamodel.rst Doc/reference/expressions.rst Doc/reference/import.rst Doc/reference/simple_stmts.rst -Doc/tutorial/controlflow.rst Doc/tutorial/datastructures.rst Doc/tutorial/introduction.rst Doc/using/cmdline.rst diff --git a/Doc/tutorial/controlflow.rst b/Doc/tutorial/controlflow.rst index 4bcc376..aa9caa1 100644 --- a/Doc/tutorial/controlflow.rst +++ b/Doc/tutorial/controlflow.rst @@ -534,7 +534,7 @@ This example, as usual, demonstrates some new Python features: Different types define different methods. Methods of different types may have the same name without causing ambiguity. (It is possible to define your own object types and methods, using *classes*, see :ref:`tut-classes`) - The method :meth:`~list.append` shown in the example is defined for list objects; it + The method :meth:`!append` shown in the example is defined for list objects; it adds a new element at the end of the list. In this example it is equivalent to ``result = result + [a]``, but more efficient. @@ -1046,7 +1046,7 @@ Function Annotations information about the types used by user-defined functions (see :pep:`3107` and :pep:`484` for more information). -:term:`Annotations <function annotation>` are stored in the :attr:`__annotations__` +:term:`Annotations <function annotation>` are stored in the :attr:`!__annotations__` attribute of the function as a dictionary and have no effect on any other part of the function. Parameter annotations are defined by a colon after the parameter name, followed by an expression evaluating to the value of the annotation. Return annotations are |