diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-01-08 22:57:24 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-01-09 00:32:07 +0900 |
| commit | 5867416612368ca7109541569b2815332ee20616 (patch) | |
| tree | 3f0c7b40844bb0104caf61826c057ec0abd4a1dd /doc/extdev | |
| parent | ae8fc43024d7feef21127b320bc35759bfbea877 (diff) | |
| download | sphinx-git-5867416612368ca7109541569b2815332ee20616.tar.gz | |
refactor: Add sphinx.util.inspect.signature()
As a successor of sphinx.util.inspect.Singnature, this adds
signature() function behaves like `inspect.signature()`. It is
very similar to way of python's inspect module.
In addition, this also adds stringify_annotation() helper to
sphinx.util.inspect module. With these two functions, we can move
to python's Signature object to represent function signatures
perfectly. It's natural design for python developers than ever.
Diffstat (limited to 'doc/extdev')
| -rw-r--r-- | doc/extdev/deprecated.rst | 15 |
1 files changed, 3 insertions, 12 deletions
diff --git a/doc/extdev/deprecated.rst b/doc/extdev/deprecated.rst index ec6db2c16..6c2b05816 100644 --- a/doc/extdev/deprecated.rst +++ b/doc/extdev/deprecated.rst @@ -81,20 +81,11 @@ The following is a list of deprecated interfaces. - 4.0 - N/A - * - ``sphinx.util.inspect.Signature.format_annotation()`` + * - ``sphinx.util.inspect.Signature`` - 2.4 - 4.0 - - ``sphinx.util.typing.stringify()`` - - * - ``sphinx.util.inspect.Signature.format_annotation_new()`` - - 2.4 - - 4.0 - - ``sphinx.util.typing.stringify()`` - - * - ``sphinx.util.inspect.Signature.format_annotation_old()`` - - 2.4 - - 4.0 - - ``sphinx.util.typing.stringify()`` + - ``sphinx.util.inspect.signature`` and + ``sphinx.util.inspect.stringify_signature()`` * - ``sphinx.builders.gettext.POHEADER`` - 2.3 |