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 docstrings into standard (propose Google) docstring format #39

Open
sadielbartholomew opened this issue Mar 18, 2024 · 0 comments
Assignees

Comments

@sadielbartholomew
Copy link
Member

Presently the docstrings in the codebase are in some format I do not recognise, so we should convert them into a standardised format that is recognised by the Sphinx docs builder.

Since cf-python uses a format closely aligned with the Google standard, it makes sense to be consistent with that and to use the same, so that is my choice unless anyone has any objections.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant