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

Conversions Adds Type Hints to Google Style Docstrings. #133

Open
jorgegomezcq opened this issue Oct 17, 2023 · 0 comments
Open

Conversions Adds Type Hints to Google Style Docstrings. #133

jorgegomezcq opened this issue Oct 17, 2023 · 0 comments

Comments

@jorgegomezcq
Copy link

jorgegomezcq commented Oct 17, 2023

Hi,

With the latest commit as of today, 684a742, the default functionality of converting from ReST to Google style docstrings adds type information to the converted docstrings but it is very common to not specify type annotations in docstrings since parsers such as the one (griffe) used in mkdocs/mkdocstrings, can get the information from the actual function signature.

The fact that the default behaviour adds these type annotations in causes a lot of extra work to remove them.

What do you think if we had a way to configure this to be off by default?

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

No branches or pull requests

1 participant