search

keras-team / keras-autodoc

Documentation autogeneration utilities.
Apache License 2.0
30 stars 22 forks source link

Extend the doctoring for the `Args` argument too #91

Open Anselmoo opened 3 years ago

Anselmoo commented 3 years ago

Adding Args

is it possible to extend the if comparison by Args, too?

According to https://google.github.io/styleguide/pyguide.html to use Args instead of Arguments is valid as well as official proposed and allows to be consistent with other packages, too.

https://github.com/keras-team/keras-autodoc/blob/0d7d1cde3bb4cd8020afd53385d33b34454bc4e6/keras_autodoc/docstring.py#L73

Workaround / Solution

if section_title == "Arguments" or section_title == "Args":