sphinx-doc / sphinx-doc/sphinx
autofunction does not support type comment for class object
Open
Nobody has claimed this yet.
extensions:autodoc
type:bug
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
autofunction does not support type comment for class object.
The type hint in type comment of __init__ method is not shown.
To Reproduce
.. autofunction:: example.Foo
class Foo:
def __init__(self, x, y):
# type: (int, str) -> List[int]
pass
Expected behavior
The type hint is shown.
Your project
No
Screenshots
No
Environment info
- OS: Mac
- Python version: 3.8.2
- Sphinx version: 3.1.0dev
- Sphinx extensions: sphinx.ext.autodoc
- Extra tools: No
Additional context
refs: https://github.com/sphinx-doc/sphinx/pull/7624#issuecomment-625181216
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at sphinx.ext.autodoc and trace how .. autofunction:: handles a class object and its init method. Reproduce the example with the type comment, then add coverage for the expected displayed type hint and verify the relevant autodoc tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100