Skip to content

Commit

Permalink
pythongh-101100: Fix Sphinx nitpicks in library/inspect.rst and `re…
Browse files Browse the repository at this point in the history
…ference/simple_stmts.rst` (python#113107)
  • Loading branch information
AlexWaygood authored and Glyphack committed Jan 27, 2024
1 parent f517b0b commit fa6af7d
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
4 changes: 4 additions & 0 deletions Doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,10 @@
# be resolved, as the method is currently undocumented. For context, see
# https://github.com/python/cpython/pull/103289.
('py:meth', '_SubParsersAction.add_parser'),
# Attributes that definitely should be documented better,
# but are deferred for now:
('py:attr', '__annotations__'),
('py:attr', '__wrapped__'),
]

# gh-106948: Copy standard C types declared in the "c:type" domain to the
Expand Down
6 changes: 3 additions & 3 deletions Doc/reference/simple_stmts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ Assignment of an object to a single target is recursively defined as follows.
object. This can either replace an existing key/value pair with the same key
value, or insert a new key/value pair (if no key with the same value existed).

For user-defined objects, the :meth:`__setitem__` method is called with
For user-defined objects, the :meth:`~object.__setitem__` method is called with
appropriate arguments.

.. index:: pair: slicing; assignment
Expand Down Expand Up @@ -351,7 +351,7 @@ If the right hand side is present, an annotated
assignment performs the actual assignment before evaluating annotations
(where applicable). If the right hand side is not present for an expression
target, then the interpreter evaluates the target except for the last
:meth:`__setitem__` or :meth:`__setattr__` call.
:meth:`~object.__setitem__` or :meth:`~object.__setattr__` call.

.. seealso::

Expand Down Expand Up @@ -932,7 +932,7 @@ That is not a future statement; it's an ordinary import statement with no
special semantics or syntax restrictions.

Code compiled by calls to the built-in functions :func:`exec` and :func:`compile`
that occur in a module :mod:`M` containing a future statement will, by default,
that occur in a module :mod:`!M` containing a future statement will, by default,
use the new syntax or semantics associated with the future statement. This can
be controlled by optional arguments to :func:`compile` --- see the documentation
of that function for details.
Expand Down
2 changes: 0 additions & 2 deletions Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ Doc/library/http.client.rst
Doc/library/http.cookiejar.rst
Doc/library/http.server.rst
Doc/library/importlib.rst
Doc/library/inspect.rst
Doc/library/locale.rst
Doc/library/logging.config.rst
Doc/library/logging.handlers.rst
Expand Down Expand Up @@ -116,7 +115,6 @@ Doc/reference/compound_stmts.rst
Doc/reference/datamodel.rst
Doc/reference/expressions.rst
Doc/reference/import.rst
Doc/reference/simple_stmts.rst
Doc/tutorial/datastructures.rst
Doc/using/windows.rst
Doc/whatsnew/2.0.rst
Expand Down

0 comments on commit fa6af7d

Please sign in to comment.