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

Add rocotorc documentation when using scrontab #3417

Merged

Conversation

DavidHuber-NOAA
Copy link
Contributor

@DavidHuber-NOAA DavidHuber-NOAA commented Mar 5, 2025

Description

Update the scrontab documentation to include information on the rocotorc file.

Resolves #3416

Type of change

  • Maintenance (code refactor, clean-up, new CI test, etc.)

Change characteristics

  • Is this a breaking change (a change in existing functionality)? NO
  • Does this change require a documentation update? YES
  • Does this change require an update to any of the following submodules? NO

How has this been tested?

Generated the documentation

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have documented my code, including function, input, and output descriptions
  • My changes generate no new warnings
  • New and existing tests pass with my changes
  • This change is covered by an existing CI test or a new one has been added
  • I have made corresponding changes to the system documentation if necessary

DavidHuber-NOAA and others added 2 commits March 5, 2025 14:00
Co-authored-by: Eric Sinsky - NOAA <48259628+EricSinsky-NOAA@users.noreply.github.com>
@DavidHuber-NOAA DavidHuber-NOAA marked this pull request as ready for review March 5, 2025 19:14
EricSinsky-NOAA
EricSinsky-NOAA previously approved these changes Mar 5, 2025
Copy link
Contributor

@EricSinsky-NOAA EricSinsky-NOAA left a comment

Choose a reason for hiding this comment

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

All changes look good to me. Thank you for adding documentation for this.

aerorahul
aerorahul previously approved these changes Mar 5, 2025
Copy link
Contributor

@aerorahul aerorahul left a comment

Choose a reason for hiding this comment

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

lgtm

@DavidHuber-NOAA
Copy link
Contributor Author

I just a quick change to the path in the error message produced by the _check_rocotorc. It should be good to go now.

@DavidHuber-NOAA DavidHuber-NOAA changed the title Feature/doc scrontab Add rocotorc documentation when using scrontab Mar 5, 2025
@DavidHuber-NOAA DavidHuber-NOAA merged commit a87a635 into NOAA-EMC:develop Mar 5, 2025
6 checks passed
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.

rocotorc error when setting up global-workflow experiment
3 participants