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

consider changing the docstring style #293

Open
jspaaks opened this issue May 4, 2021 · 2 comments
Open

consider changing the docstring style #293

jspaaks opened this issue May 4, 2021 · 2 comments
Labels
generated-package Related to the generated package, i.e. after running cookiecutter

Comments

@jspaaks
Copy link

jspaaks commented May 4, 2021

because its restructured text format is currently at odds with the markdown used in other places
@jspaaks jspaaks added the generated-package Related to the generated package, i.e. after running cookiecutter label May 4, 2021
@bouweandela
Copy link
Member

bouweandela commented May 18, 2021 •
edited
Loading

Note that this repository should be aligned with what is recommended in the guide. It looks like we recommend google style docstrings at the moment. If it is changed here, it should also be changed in the guide and vice versa.

@egpbos
Copy link
Member

egpbos commented Mar 30, 2022

Where do we define the docstring style in this repo? I would recommend adding linting of docstrings and indeed setting it to Google style by default. We have also done so in the DIANNA project, if someone wants to copy from there: https://github.com/dianna-ai/dianna/blob/40148ae9365f2444df578484adb8104b4bee3506/.prospector.yml#L34

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
generated-package Related to the generated package, i.e. after running cookiecutter
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jspaaks @bouweandela @egpbos