Skip to content

Conversation

maddenp-cu
Copy link
Collaborator

@maddenp-cu maddenp-cu commented Aug 19, 2024

Synopsis

Provide direct access to Config subclasses (YAMLConfig et al.) via uwtools.api.config.

Type

  • Documentation
  • Enhancement (adds new functionality)

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-cu maddenp-cu self-assigned this Aug 19, 2024
Copy link
Contributor

@WeirAE WeirAE left a comment

Choose a reason for hiding this comment

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

Some fussy Sphinx rules and swapping of public/private methods, but worth the trouble - LGTM

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.

I was having a bit of trouble tracking the reorg vs changes in the tests, but I think it looks good.

maddenp-cu and others added 2 commits August 19, 2024 17:58
Co-authored-by: Christina Holt <56881914+christinaholtNOAA@users.noreply.github.com>
@maddenp-cu maddenp-cu merged commit a99fe8f into ufs-community:main Aug 20, 2024
2 checks passed
@maddenp-cu maddenp-cu deleted the config-classes-to-api branch August 20, 2024 00:18
Byrnetp added a commit that referenced this pull request Sep 3, 2024
* update_values() -> update_from() (#578)

* DRY out Driver._validate() (#579)

* Move execute() to its own API namespace, disambiguate (#580)

* Config classes to API (#582)

* Simplify unknown-extension error message (#584)

* UW-657 fs makedirs (#572)

* Docstring cleanup (#585)

* GH 586 bad stdin_ok prompt (#587)

* Fix issue with creating a metatask dep. (#589)

The rocoto schema is set up to allow metataskdep entries in the YAML, but the logic was not included in the tool to handle them. This addition fixes that.

* Add --show-schema support to drivers (#588)

* add file system notebook, unit tests, binder links

* Add missing newlines

* Add a table of contents

* Makefile and .gitignore changes from review

* Apply suggestions from code review

Co-authored-by: Paul Madden <136389411+maddenp-noaa@users.noreply.github.com>

* Apply review suggestions to all sections of the notebook

* Specific rmtree() targeting and output cell test update

* Apply suggestions from code review

Co-authored-by: Paul Madden <136389411+maddenp-noaa@users.noreply.github.com>

---------

Co-authored-by: Paul Madden <136389411+maddenp-noaa@users.noreply.github.com>
Co-authored-by: Christina Holt <56881914+christinaholtNOAA@users.noreply.github.com>
Byrnetp added a commit that referenced this pull request Oct 17, 2024
* update_values() -> update_from() (#578)

* DRY out Driver._validate() (#579)

* Move execute() to its own API namespace, disambiguate (#580)

* Config classes to API (#582)

* Simplify unknown-extension error message (#584)

* UW-657 fs makedirs (#572)

* Docstring cleanup (#585)

* GH 586 bad stdin_ok prompt (#587)

* Fix issue with creating a metatask dep. (#589)

The rocoto schema is set up to allow metataskdep entries in the YAML, but the logic was not included in the tool to handle them. This addition fixes that.

* Add --show-schema support to drivers (#588)

* Config notebook p2 and example notebook removal

* removing merge diff text

* pin python version for RtD

* improvements from code review

* add config.compare() format mismatch example

* Remove typo

Co-authored-by: Emily Carpenter <137525341+elcarpenterNOAA@users.noreply.github.com>

---------

Co-authored-by: Paul Madden <136389411+maddenp-noaa@users.noreply.github.com>
Co-authored-by: Christina Holt <56881914+christinaholtNOAA@users.noreply.github.com>
Co-authored-by: Emily Carpenter <137525341+elcarpenterNOAA@users.noreply.github.com>
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