Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Option for not-adding the types of the parameters in the "Parameters" section #4

Closed
twmr opened this issue May 9, 2021 · 2 comments · Fixed by #5
Closed

Option for not-adding the types of the parameters in the "Parameters" section #4

twmr opened this issue May 9, 2021 · 2 comments · Fixed by #5

Comments

@twmr
Copy link

twmr commented May 9, 2021

Thx a lot for this nice package that has proper support for type annotations and numpydoc-style docstrings!

Since the sphinx html output contains the type annotations in the signature of the functions/methods (can be controlled by setting the autodoc_typehints sphinx-config var), it is not needed that that the types are displayed again in the "Parameters" section. Therefore, I think it makes sense to make to make it configurable, whether the types are shown or not.

@douglasdavis
Copy link
Owner

I like the idea! it's been added, please open a new issue if you run into any problems

@twmr
Copy link
Author

twmr commented May 11, 2021

Thx a lot for the quick fix!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants