]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and `reference/simple_...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Thu, 14 Dec 2023 13:37:38 +0000 (14:37 +0100)
committerGitHub <noreply@github.com>
Thu, 14 Dec 2023 13:37:38 +0000 (13:37 +0000)
gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and `reference/simple_stmts.rst` (GH-113107)
(cherry picked from commit 4b3cb082da82da744f5db0b7315aa80558c51557)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Doc/conf.py
Doc/reference/simple_stmts.rst
Doc/tools/.nitignore

index cd890d5076a10f6d96cdef57fc10b1100c02436b..004125344e1c311b73a89343bcf6f9c10431247a 100644 (file)
@@ -231,6 +231,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 8efcf289c9b6635c29ccd67cdb9435da16e9528b..1a94a94e46776ed80042f7d42c7445d2519b118f 100644 (file)
@@ -213,7 +213,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
@@ -350,7 +350,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::
 
@@ -931,7 +931,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 543eddbea6b400ec2e7cee96c9a5283f7cbf8869..b48c749f4f2d7ddb6ca482ead0df48f8873bfeec 100644 (file)
@@ -62,7 +62,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
@@ -120,7 +119,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