IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Deprecate sphinx.util.inspect.Parameter

Browse Source
This commit is contained in:
Takeshi KOMIYA 2018-12-15 20:48:30 +09:00
parent a1e845d964
commit 6b24c069c3
3 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES
View File

@ -62,7 +62,8 @@ Deprecated
* ``sphinx.testing.util.remove_unicode_literal()`` * ``sphinx.testing.util.remove_unicode_literal()``
* ``sphinx.util.attrdict`` * ``sphinx.util.attrdict``
* ``sphinx.util.force_decode()`` * ``sphinx.util.force_decode()``
* ``sphinx.util.get_matching_docs()`` is deprecated * ``sphinx.util.get_matching_docs()``
* ``sphinx.util.inspect.Parameter``
* ``sphinx.util.osutil.walk()`` * ``sphinx.util.osutil.walk()``
* ``sphinx.util.PeekableIterator`` * ``sphinx.util.PeekableIterator``
* ``sphinx.util.pycompat.u`` * ``sphinx.util.pycompat.u``

5
doc/extdev/index.rst
View File

@ -202,6 +202,11 @@ The following is a list of deprecated interfaces.
- 4.0 - 4.0
- ``sphinx.util.get_matching_files()`` - ``sphinx.util.get_matching_files()``
* - ``sphinx.util.inspect.Parameter``
- 2.0
- 3.0
- N/A
* - ``sphinx.util.osutil.walk()`` * - ``sphinx.util.osutil.walk()``
- 2.0 - 2.0
- 4.0 - 4.0

5
sphinx/util/inspect.py
View File

@ -16,10 +16,12 @@ import inspect
import re import re
import sys import sys
import typing import typing
import warnings
from functools import partial from functools import partial
from six import StringIO from six import StringIO
from sphinx.deprecation import RemovedInSphinx30Warning
from sphinx.util import logging from sphinx.util import logging
from sphinx.util.pycompat import NoneType from sphinx.util.pycompat import NoneType
@ -289,6 +291,9 @@ class Parameter:
self.default = default self.default = default
self.annotation = self.empty self.annotation = self.empty
warnings.warn('sphinx.util.inspect.Parameter is deprecated.',
RemovedInSphinx30Warning, stacklevel=2)
class Signature: class Signature:
"""The Signature object represents the call signature of a callable object and """The Signature object represents the call signature of a callable object and