Skip to content

Commit

Permalink
pythongh-101100: Silence Sphinx warnings when ntpath or posixpath
Browse files Browse the repository at this point in the history
… are referenced (python#112833)
  • Loading branch information
AlexWaygood authored and aisk committed Feb 11, 2024
1 parent d1cfbb7 commit b4abd1b
Show file tree
Hide file tree
Showing 4 changed files with 8 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 @@ -166,6 +166,10 @@
# 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.
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/pathlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions Doc/whatsnew/3.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit b4abd1b

Please sign in to comment.