]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-101100: Silence Sphinx warnings when `ntpath` or `posixpath` are referenced (...
authorAlex Waygood <Alex.Waygood@Gmail.com>
Thu, 7 Dec 2023 20:57:30 +0000 (20:57 +0000)
committerGitHub <noreply@github.com>
Thu, 7 Dec 2023 20:57:30 +0000 (20:57 +0000)
Doc/conf.py
Doc/library/pathlib.rst
Doc/tools/.nitignore
Doc/whatsnew/3.7.rst

index 323d443588ceb63c4a352d1b4c8d21d34f88b0e7..f2d36fdc70430c0366a261dc3414ccc67c38fab2 100644 (file)
@@ -166,6 +166,10 @@ nitpick_ignore = [
     # Deprecated function that was never documented:
     ('py:func', 'getargspec'),
     ('py:func', 'inspect.getargspec'),
+    # Undocumented modules that users shouldn't have to worry about
+    # (implementation details of `os.path`):
+    ('py:mod', 'ntpath'),
+    ('py:mod', 'posixpath'),
 ]
 
 # Temporary undocumented names.
index 62d4ed5e3f46b97c1b191d01ffa65f009b310397..43200e269f56f4d05e249bb65388e17f3d827fa7 100644 (file)
@@ -306,7 +306,7 @@ Pure paths provide the following methods and properties:
 .. attribute:: PurePath.pathmod
 
    The implementation of the :mod:`os.path` module used for low-level path
-   operations: either ``posixpath`` or ``ntpath``.
+   operations: either :mod:`posixpath` or :mod:`ntpath`.
 
    .. versionadded:: 3.13
 
index ada1fc5fafc9c93c7be2e5ffd26dff3cea455bb6..8a033f019372f7f0bc4cbd82f46c7ad330f86ed4 100644 (file)
@@ -72,7 +72,6 @@ Doc/library/multiprocessing.rst
 Doc/library/multiprocessing.shared_memory.rst
 Doc/library/numbers.rst
 Doc/library/optparse.rst
-Doc/library/os.path.rst
 Doc/library/os.rst
 Doc/library/pickle.rst
 Doc/library/pickletools.rst
index 99f280af84ab01517abd2c5d44f6cadd72b78ed6..7a74f9c1685c312a0692f8c9d62a6e2f6f48529c 100644 (file)
@@ -2144,9 +2144,9 @@ The following features and APIs have been removed from Python 3.7:
 * Removed support of the *exclude* argument in :meth:`tarfile.TarFile.add`.
   It was deprecated in Python 2.7 and 3.2.  Use the *filter* argument instead.
 
-* The ``splitunc()`` function in the :mod:`ntpath` module was deprecated in
-  Python 3.1, and has now been removed.  Use the :func:`~os.path.splitdrive`
-  function instead.
+* The :func:`!ntpath.splitunc` function was deprecated in
+  Python 3.1, and has now been removed.  Use :func:`~os.path.splitdrive`
+  instead.
 
 * :func:`collections.namedtuple` no longer supports the *verbose* parameter
   or ``_source`` attribute which showed the generated source code for the