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

Following stricter docstring formatting #45

Open
sobolevnrm opened this issue May 25, 2020 · 3 comments
Open

Following stricter docstring formatting #45

sobolevnrm opened this issue May 25, 2020 · 3 comments
Assignees
Labels

Comments

@sobolevnrm
Copy link
Collaborator

I've been loosely following Google-style docstrings in the code; it would be better to follow the official Python guidance.

@sobolevnrm
Copy link
Collaborator Author

Or just do a better job following this: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html

@orbeckst
Copy link
Collaborator

I started a Style Guide on the wiki@sobolevnrm @speleo3 please edit as necessary, these are just stubs. But I think it's helpful to start aggregating best practices and information as this makes it a lot easier when on-boarding other contributors (and our future selves, of course).

@orbeckst orbeckst added the docs label Jun 18, 2020
@sobolevnrm
Copy link
Collaborator Author

Fantastic -- thank you, @orbeckst !

@sobolevnrm sobolevnrm self-assigned this Aug 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants