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

Docs update with DocStringExtensions #98

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

jb-mackay
Copy link
Contributor

@jb-mackay jb-mackay commented Jul 22, 2022

Purpose and Content

Adds DocStringExtensions.jl to the src directory. Primarily uses DocStringExtensions.@template to create uniform docstrings. Also updates the API docs.

Benefits and Risks

DocStringExtensions will make our docs more robust to code changes (signature updates, field updates, etc). Using @template also ensures that the same information is included in docstrings for the same types of info (methods, types, etc) and streamlines what we need to write.

Linked Issues

Closes #64
Part of #84

PR Checklist

  • This PR has a corresponding issue OR is linked to an SDI.
  • I have followed CliMA's codebase contribution and style guidelines OR N/A.
  • I have followed CliMA's documentation policy.
  • I have checked all issues and PRs and I certify that this PR does not duplicate an open PR.
  • I linted my code on my local machine prior to submission OR N/A.
  • Unit tests are included OR N/A.
  • Code used in an integration test OR N/A.
  • All tests ran successfully on my local machine OR N/A.
  • All classes, modules, and function contain docstrings OR N/A.
  • Documentation has been added/updated OR N/A.

@jb-mackay jb-mackay self-assigned this Jul 22, 2022
@jb-mackay jb-mackay added the documentation Improvements or additions to documentation label Jul 22, 2022
@LenkaNovak LenkaNovak mentioned this pull request Mar 20, 2023
24 tasks
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

Successfully merging this pull request may close these issues.

Use DocStringExtensions
1 participant