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.

Sign up for GitHub

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

Jump to bottom

Add google docstring format #12

Open
mjhajharia opened this issue Mar 27, 2023 · 1 comment
Open

Add google docstring format #12

mjhajharia opened this issue Mar 27, 2023 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@mjhajharia
Copy link
Owner

mjhajharia commented Mar 27, 2023 •
edited
Loading

Minimal version of the idea is to have a kwarg in the sphinx decorator that lets you choose the kind of docstrings you have with args being numpydoc, google. Currently, only Numpydoc is supported as it is more common in a lot of open source software, but sphinx supports google docstrings as well.

You'd only want to change the regex for finding the position in the docstring.
@mjhajharia mjhajharia added enhancement New feature or request help wanted Extra attention is needed labels Mar 27, 2023
@mjhajharia
Copy link
Owner Author

https://github.com/mjhajharia/deprecat/blob/main/deprecat/sphinx.py#L153-L218

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mjhajharia