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

Improve docstring for Strategy #464

Closed
danieljanes opened this issue Nov 8, 2020 · 3 comments · Fixed by #470
Closed

Improve docstring for Strategy #464

danieljanes opened this issue Nov 8, 2020 · 3 comments · Fixed by #470
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@danieljanes
Copy link
Member

No description provided.

@danieljanes danieljanes created this issue from a note in Basic Documentation (To do) Nov 8, 2020
@danieljanes danieljanes added the documentation Improvements or additions to documentation label Nov 8, 2020
@danieljanes danieljanes moved this from To do to Review in progress in Basic Documentation Nov 10, 2020
@pedropgusmao
Copy link
Contributor

Are we sticking to a specific docstring style? I found a few here that we could choose from. I particularly like the Numpydoc.

@danieljanes
Copy link
Member Author

Good question - we've never defined and documented the style we want to use for Flower, but you're right, we should pick one and declare it as the official style. It should be one that plays well with Sphinx to enable us to link to other parts of the codebase from the docstring itself. We've also started to use docformatter, so it would be good to pick a style that docformatter understands.

Perhaps it's best if we build a very small demo that showcases how a good docstrin in the format we pick looks like, how it can link to / mention other code fragments, and how docformatter itneracts with it. Would you like to take this topic @pedropgusmao ?

@danieljanes
Copy link
Member Author

Btw, I like the Numpydoc style as well. We sometimes have rather involved type signatures, so it helps to have a dedicated line for that. We should also pick a style that makes it clear which parameters are optional and what their default values are.

Basic Documentation automation moved this from Review in progress to Done Nov 11, 2020
@pedropgusmao pedropgusmao self-assigned this Nov 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging a pull request may close this issue.

2 participants