sphinx-contrib / napoleon

Other
149 stars 48 forks source link

disable alias of docstring sections #45

Open liebsc21 opened 1 year ago

liebsc21 commented 1 year ago

I was wonderwing what's the best way to doc kwargs in google style. After reading this I find it best to list **kwargs in the Args section (to comply with the Google Python Stye Guide and darglint) and on top of that document the specific keys of kwargs under Keyword Args.

However, in this case the rendered sections Parameters as alias of Args and Keyword Arguments do not fit nicely together.

Is it possible to disabled the alias and render the Args section as Args (or Arguments).