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

Fix #8597: autodoc: metadata only docstring is treated as undocumented

Browse Source 
The metadata in docstring is invisible content. Therefore docstring
having only metadata should be treated as undocumented.
This commit is contained in:
Takeshi KOMIYA
2021-05-02 22:44:44 +09:00
parent 30237c004d
commit 469def56b6
7 changed files with 93 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/extdev/deprecated.rst
View File

@@ -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