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

UW-509 docs for sfc_climo_gen driver #412

Merged
merged 18 commits into from
Feb 23, 2024

Conversation

maddenp-noaa
Copy link
Collaborator

@maddenp-noaa maddenp-noaa commented Feb 20, 2024

Synopsis

Documentation for the sfc_climo_gen driver. Preview here.

Type

  • Documentation

Impact

  • This is a non-breaking change (existing functionality continues to work as expected)

Checklist

  • I have added myself and any co-authors to the PR's Assignees list.
  • I have reviewed the documentation and have made any updates necessitated by this change.

@maddenp-noaa maddenp-noaa self-assigned this Feb 20, 2024
Copy link
Collaborator

@christinaholtNOAA christinaholtNOAA left a comment

Choose a reason for hiding this comment

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

This all looks great!

I left a few things below, but also noticed that we need an additional entry in the index.rst of the docs home page under drivers.

docs/sections/user_guide/yaml/execution.rst Outdated Show resolved Hide resolved
docs/sections/user_guide/yaml/execution.rst Show resolved Hide resolved
docs/sections/user_guide/cli/index.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@NaureenBharwaniNOAA NaureenBharwaniNOAA left a comment

Choose a reason for hiding this comment

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

Looks great!

@maddenp-noaa maddenp-noaa merged commit dd2a766 into ufs-community:main Feb 23, 2024
2 checks passed
@maddenp-noaa maddenp-noaa deleted the UW-509 branch February 23, 2024 23:20
WeirAE pushed a commit to WeirAE/workflow-tools that referenced this pull request Feb 27, 2024
WeirAE added a commit that referenced this pull request Feb 29, 2024
* edit config error message and test

* modify error text for clarity and doc text
Explicit typing doc in progress

* Updated to allow YAML as output always

* missed error documentation update

* modified representer for f90nml

* update to prod mode_config.rst for resolution

* for some reason, a space

* UW-509 docs for sfc_climo_gen driver (#412)

* Obtain iotaa from conda-forge (#415)

* Add conda badges and update pylint (#416)

* modify error text for clarity and doc text
Explicit typing doc in progress

* Updated to allow YAML as output always

* missed error documentation update

* update to prod mode_config.rst for resolution

* for some reason, a space

* Update error message and documentation

* Changes as follows below:
Moved representers to support.py
Moved OrderedDict logic to its own representer

* updated recursive function within ordereddict

* Update src/uwtools/config/support.py

Co-authored-by: Paul Madden <[email protected]>

* Update src/uwtools/config/support.py

Co-authored-by: Paul Madden <[email protected]>

* Update src/uwtools/config/support.py

Co-authored-by: Paul Madden <[email protected]>

* Update src/uwtools/config/support.py

Co-authored-by: Paul Madden <[email protected]>

* Update src/uwtools/config/support.py

Co-authored-by: Paul Madden <[email protected]>

* Update src/uwtools/config/support.py

Co-authored-by: Paul Madden <[email protected]>

* Update src/uwtools/config/support.py

Co-authored-by: Paul Madden <[email protected]>

* fix f90nml calls for cleanliness

* consolidate representers and test

* Update src/uwtools/config/support.py

Co-authored-by: Paul Madden <[email protected]>

* fix organization and doc string

* formatting

---------

Co-authored-by: Paul Madden <[email protected]>
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.

5 participants