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

Fix doc-strings #13

Closed
josephmckinsey opened this issue Nov 12, 2024 · 0 comments
Closed

Fix doc-strings #13

josephmckinsey opened this issue Nov 12, 2024 · 0 comments

Comments

@josephmckinsey
Copy link
Collaborator

Many doc-strings in the current code base are actually just comments. I would like to replace these with real doc-strings to support user help commands and autogenerated documentation.

For reference, we should follow something like this for our style:
https://github.com/JuliaDiff/BlueStyle?tab=readme-ov-file#documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@josephmckinsey