Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

Decide on project-wide docstring format #48

Closed
joaomcteixeira opened this issue Jul 28, 2021 · 1 comment
Closed

Decide on project-wide docstring format #48

joaomcteixeira opened this issue Jul 28, 2021 · 1 comment
Labels
enhancement Enhancing an existing feature of adding a new one

Comments

@joaomcteixeira
Copy link
Member

We should probably decide on a format and implement it in the whole project, lets save it for another issue.

Originally posted by @rvhonorato in #41 (comment)
@rvhonorato rvhonorato changed the title Revisit generate_topology Decide on project-wide docstring format Jul 29, 2021
@joaomcteixeira
Copy link
Member Author

I normally use numpy doc because it is well integrated with sphinx and ReadTheDocs. But I have no personal preference, I will adapt to any format.

@joaomcteixeira joaomcteixeira added the enhancement Enhancing an existing feature of adding a new one label Jul 29, 2021
@haddocking haddocking locked and limited conversation to collaborators Jul 31, 2021

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Assignees
No one assigned
Labels
enhancement Enhancing an existing feature of adding a new one
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@joaomcteixeira @rvhonorato