diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2021-05-02 16:44:44 +0300 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2021-05-02 17:17:58 +0300 |
| commit | 469def56b64e0a4b09c892dc4eaa0f0565841789 (patch) | |
| tree | e8d8c0072621f9545944778ea7e6d803c4800366 /doc/extdev | |
| parent | 30237c004d3faebbcddbf12fc319b9c02e593b65 (diff) | |
Fix #8597: autodoc: metadata only docstring is treated as undocumented
The metadata in docstring is invisible content. Therefore docstring
having only metadata should be treated as undocumented.
Diffstat (limited to 'doc/extdev')
| -rw-r--r-- | doc/extdev/deprecated.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/extdev/deprecated.rst b/doc/extdev/deprecated.rst index 9e17b9fb4..514a80541 100644 --- a/doc/extdev/deprecated.rst +++ b/doc/extdev/deprecated.rst @@ -22,6 +22,11 @@ The following is a list of deprecated interfaces. - (will be) Removed - Alternatives + * - ``sphinx.util.docstrings.extract_metadata()`` + - 4.1 + - 6.0 + - ``sphinx.util.docstrings.separate_metadata()`` + * - ``favicon`` variable in HTML templates - 4.0 - TBD |