dadadel / pyment

Format and convert Python docstrings and generates patches
GNU General Public License v3.0
905 stars 62 forks source link

Conversions Adds Type Hints to Google Style Docstrings. #133

Open jorgegomezcq opened 1 year ago

jorgegomezcq commented 1 year ago

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?