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

Support for numpy docstrings #64

Open
vocx-fc opened this issue Jul 31, 2019 · 3 comments
Open

Support for numpy docstrings #64

vocx-fc opened this issue Jul 31, 2019 · 3 comments

Comments

@vocx-fc
Copy link

vocx-fc commented Jul 31, 2019

It seems that doxypypy can parse the Google docstring style well. What about numpy style? I think this style should also be recognized as it's one of the most common styles, used by many in the scientific community.

@Feneric
Copy link
Owner

Feneric commented Sep 8, 2019

I've never personally tried. I've been told at least one other person has had limited success with it.

Patches (with tests) would certainly be welcome! There is nothing preventing doxypypy from incorporating the functionality and there is no anti-NumPy sentiment at play here. It's just that there has not yet been enough interest from devs to make it happen.

@vocx-fc
Copy link
Author

vocx-fc commented Sep 8, 2019

Thank you for the reply.

I hope I don't sound too demanding. Since you know the code well maybe it's easier for you to add this support with the examples that I provide above. I could try to do it, but that would take me a long time because I would need to understand how doxypypy works. I'm not familiar with "Python's own abstract syntax tree walker".

@MuellerSeb
Copy link

I guess the simplest way to do so is to involve pyment in the py_filter script.
You create a temporary file, where the numpy docstrings style is converted to google docstring style and the apply doxypypy to the temporary file.

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

3 participants