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

doc: remove mention of renamed variable 'forcing_diag' #657

Merged
merged 1 commit into from
Nov 5, 2021

Conversation

phil-blain
Copy link
Member

@phil-blain phil-blain commented Nov 5, 2021

'forcing_diag' was renamed to 'debug_forcing' in d6eb125 (Add new unit
tests sumchk and bcstchk and update tests (#606), 2021-06-09), but this
instance was not renamed in the doc.

PR checklist

  • Short (1 sentence) summary of your PR:
    see title
  • Developer(s):
    me
  • 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.
    None - doc fix only
  • 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 Icepack 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/. A test build of the technical docs will be performed as part of the PR testing.)
    • Yes
    • No, does the documentation need to be updated at a later time?
      • Yes
      • No
  • Please provide any additional information or relevant details below:

'forcing_diag' was renamed to 'debug_forcing' in d6eb125 (Add new unit
tests sumchk and bcstchk and update tests (#606), 2021-06-09), but this
instance was not renamed in the doc.

'forcing_diag' was renamed to 'debug_forcing' in d6eb125 (Add new unit
tests sumchk and bcstchk and update tests (CICE-Consortium#606), 2021-06-09), but this
instance was not renamed in the doc.
@phil-blain phil-blain marked this pull request as ready for review November 5, 2021 18:14
@apcraig
Copy link
Contributor

apcraig commented Nov 5, 2021

Thanks for catching this @phil-blain, we should get rid of the "\_" in general. I don't think it's required anymore. Having the \ makes grepping for things in the documentation more difficult. Will merge once checks are complete.

@apcraig apcraig merged commit 3ea1a50 into CICE-Consortium:main Nov 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants