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

[develop] Updating ConfigWorkflow.rst file to reflect changes to Config defaults #1157

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

jdkublnick
Copy link
Collaborator

DESCRIPTION OF CHANGES:
Updated ConfigWorkflow.rst to reflect recent changes to config_defaults.yaml in order to keep documentation up to date.

Type of change
[X ] This change requires a documentation update

TESTS CONDUCTED:
None required for documentation. The docs build successfully on my fork and can be viewed at: https://ufs-srweather-app-joshua-kublnick.readthedocs.io/en/text-us-404/

DEPENDENCIES:
N/A

DOCUMENTATION:
All documentation

ISSUE:
Issue #1132

CHECKLIST
[X ] My code follows the style guidelines in the Contributor's Guide
[X ] I have performed a self-review of my own code using the Code Reviewer's Guide
I have commented my code, particularly in hard-to-understand areas
[X ] My changes need updates to the documentation. I have made corresponding changes to the documentation
My changes do not require updates to the documentation (explain).
[X ] My changes generate no new warnings
New and existing tests pass with my changes
[ X] Any dependent changes have been merged and published
LABELS (optional):
A Code Manager needs to add the following labels to this PR:

[X ] documentation

Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

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

@jdkublnick -

Thanks for adding these changes into the ConfigWorkflow.rst file! The Doc Tests GitHub Action test is failing due to the title underline being too short on line 18. Please increase the size of the underline as appropriate.

doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

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

@jdkublnick -

Thanks for making the modification to allow the Doc Tests to successfully pass!

Approving now.

@gspetro-NOAA
Copy link
Collaborator

gspetro-NOAA commented Nov 26, 2024

In the RST, FIRE_IGNITION_START_TIME is listed twice. I think the developer made a copy-paste error, and FIRE_IGNITION_START_TIME (Default: 7000) should be changed to FIRE_IGNITION_END_TIME (Default: 7000). Other than that and the few changes above, looks good!

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.

[develop]: Updated ConfigWorkflow.rst to reflect changes to config_defaults.yaml (PI14)
3 participants