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

Docstring Format #16

Open
janothan opened this issue May 18, 2021 · 0 comments
Open

Docstring Format #16

janothan opened this issue May 18, 2021 · 0 comments

Comments

@janothan
Copy link
Contributor

janothan commented May 18, 2021

Hi @mariaangelapellegrino, in your code I found some documentation of methods and parameters. However, I wonder whether you followed any specific docstring format (if so: what is the name?).

Generally, I would suggest to use a default format that is recognized by IDEs such as PyCharm.

If it is ok with you, I would start refactoring your project using the numpy format.

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

1 participant