Skip to content
This repository has been archived by the owner on Apr 26, 2023. It is now read-only.

disable alias of docstring sections #45

Open
liebsc21 opened this issue Apr 14, 2023 · 0 comments
Open

disable alias of docstring sections #45

liebsc21 opened this issue Apr 14, 2023 · 0 comments

Comments

@liebsc21
Copy link

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).

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

No branches or pull requests

1 participant