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.

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

Plan to support napoleon sphinx docstring? #19

Open
humitos opened this issue Dec 22, 2017 · 1 comment
Open

Plan to support napoleon sphinx docstring? #19

humitos opened this issue Dec 22, 2017 · 1 comment

Comments

@humitos
Copy link

humitos commented Dec 22, 2017

Are you thinking on support this style?

http://www.sphinx-doc.org/en/stable/ext/napoleon.html#napoleon-marching-toward-legible-docstrings

Thanks!

@naiquevin
Copy link
Owner

Given how this mode is implemented at present, it's be difficult to support alternate styles. But it's definitely a good idea as more people will be able to use it. I am thinking of refactoring the code to support "pluggable" styles but as I said, it'll be a big change and I can't promise any timeline.

(See also: Issue #17)

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

No branches or pull requests

2 participants