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

Convert all doc-strings to Google Style #18

Open
ns-rse opened this issue Jul 6, 2022 · 2 comments
Open

Convert all doc-strings to Google Style #18

ns-rse opened this issue Jul 6, 2022 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ns-rse
Copy link
Contributor

ns-rse commented Jul 6, 2022

Docstrings are currently written in Python's ReSructured Text.

An easier to read and more flexible docstring style is the Google Style docstrings style which Sphinx supports additional sections and renders with Sphinx via the napoleon Sphinx extension.

In particular including examples is very useful.

@ns-rse ns-rse self-assigned this Jul 6, 2022
@ns-rse ns-rse changed the title Convert all doc-strings to Numpydoc Convert all doc-strings to Google Style Jul 15, 2022
@ns-rse ns-rse added the documentation Improvements or additions to documentation label Jul 15, 2022
@jonbarker68 jonbarker68 added this to the CPC2 - pyclarity 0.2.0 milestone Jul 20, 2022
@ns-rse
Copy link
Contributor Author

ns-rse commented Feb 22, 2023

This is the only outstanding issue against CPC2 - pyclarity 0.3.0, whilst not complete I'm wondering if a release is required to align with the challenge?

@jonbarker68
Copy link
Contributor

Yes, I think so. I was just waiting for the Cadenza recipes to be final. If it's OK with @groadabike I'd propose that we close any open PRs and make a release 0.3.0 on Friday.

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
None yet
Development

No branches or pull requests

2 participants