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

Update version and interface documentation #335

Merged
merged 1 commit into from
Aug 25, 2020
Merged

Update version and interface documentation #335

merged 1 commit into from
Aug 25, 2020

Conversation

apcraig
Copy link
Contributor

@apcraig apcraig commented Aug 25, 2020

PR checklist

  • Short (1 sentence) summary of your PR:
    Update version and interface documentation in preparation for release
  • Developer(s):
    apcraig
  • Suggest PR reviewers from list in the column to the right.
  • Please copy the PR test results link or provide a summary of testing completed below.
    No testing done, code and scripts not changes, will review readthedocs before merging
  • How much do the PR code changes differ from the unmodified code?
    • bit for bit
    • different at roundoff level
    • more substantial
  • Does this PR create or have dependencies on CICE or any other models?
    • Yes
    • No
  • Does this PR add any new test cases?
    • Yes
    • No
  • Is the documentation being updated? ("Documentation" includes information on the wiki or in the .rst files from doc/source/, which are used to create the online technical docs at https://readthedocs.org/projects/cice-consortium-cice/.)
    • Yes
    • No, does the documentation need to be updated at a later time?
      • Yes
      • No
  • Please provide any additional information or relevant details below:

version was updated via icepack.setup --setvers 1.2.3
interface documentation was updated via icepack.setup --docintfc

@apcraig apcraig self-assigned this Aug 25, 2020
eclare108213
eclare108213 approved these changes Aug 25, 2020
View reviewed changes
Copy link
Contributor

@eclare108213 eclare108213 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. The change to the interface information in the documentation is automated, right? Is that process itself documented? I think it is...

@apcraig
Copy link
Contributor Author

apcraig commented Aug 25, 2020

The interface documentation is automated. If a new public interface is added, it needs to be highlighted with appropriate comments. It's all here,

https://cice-consortium-icepack.readthedocs.io/en/master/user_guide/lg_interfaces.html

@apcraig apcraig merged commit 1e6bed9 into CICE-Consortium:master Aug 25, 2020
@eclare108213
Copy link
Contributor

I see. That's very cool.

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

@eclare108213 eclare108213 eclare108213 approved these changes

@duvivier duvivier Awaiting requested review from duvivier

Assignees

@apcraig apcraig

Labels
Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@apcraig @eclare108213