]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and `reference/simple_stmts...
authorAlex Waygood <Alex.Waygood@Gmail.com>
Thu, 14 Dec 2023 13:30:57 +0000 (13:30 +0000)
committerGitHub <noreply@github.com>
Thu, 14 Dec 2023 13:30:57 +0000 (13:30 +0000)
Doc/conf.py
Doc/reference/simple_stmts.rst
Doc/tools/.nitignore

index f2d36fdc70430c0366a261dc3414ccc67c38fab2..0d7c0b553eaa741e4968637c6eb33f27af90fc65 100644 (file)
@@ -245,6 +245,10 @@ nitpick_ignore += [
     # 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
index 34c3a620b87223fe81cfa2a4a005abf508d056da..04132c78ce77a6704c3a48891f5c777632e2aeaf 100644 (file)
@@ -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
@@ -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::
 
@@ -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.
index 75d50fee33a064241ad5af975e2d9d2bcf2ff66d..c49fcf71dd33267fc0b6160ff658e8af1e397ef2 100644 (file)
@@ -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
@@ -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