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

Use DocStringExtensions #64

Closed
jb-mackay opened this issue Jun 18, 2022 · 2 comments · May be fixed by #98
Closed

Use DocStringExtensions #64

jb-mackay opened this issue Jun 18, 2022 · 2 comments · May be fixed by #98
Assignees
@jb-mackay
Labels
documentation Improvements or additions to documentation

Comments

@jb-mackay
Copy link
Contributor

jb-mackay commented Jun 18, 2022 •
edited

Improve documentation quality and robustness to future code changes by using DocStringExtensions.jl. Particularly:
FIELDS, SIGNATURES, and EXPORTS.
@jb-mackay jb-mackay added the documentation Improvements or additions to documentation label Jun 18, 2022
@jb-mackay jb-mackay self-assigned this Jun 18, 2022
@jb-mackay
Copy link
Contributor Author

jb-mackay commented Jun 22, 2022 •
edited

A PR addressing this can also update the doc format to satisfy the CliMA Documentation Policy

@LenkaNovak LenkaNovak mentioned this issue Jul 11, 2022
Closed
10 tasks
@jb-mackay jb-mackay mentioned this issue Jul 22, 2022
Open
10 tasks
@LenkaNovak
Copy link
Collaborator

@valeriabarra , this should help with the docstring task in #205

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jb-mackay jb-mackay

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs update with DocStringExtensions CliMA/ClimaCoupler.jl
2 participants
@LenkaNovak @jb-mackay