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

Docstring cleanup #585

Merged
merged 5 commits into from
Aug 21, 2024
Merged

Conversation

maddenp-noaa
Copy link
Collaborator

@maddenp-noaa maddenp-noaa commented Aug 21, 2024

Synopsis

While working on something else, I became distracted by divergences from conventions in our docstrings. I've tried to harmonize those in this PR, though I'm sure I've missed some stragglers that, if we agree on the conventions described below, we can chip away at in future work as we find them.

The conventions I've tried to adhere to -- which are the case in most of our docstrings already:

  • For action-oriented functions/methods (most of them), use active language: "Do a thing", not "Does a thing", "Return a value", not "Returns a value", etc.
  • For language objects that are rather than do -- classes, @property methods, driver workflow tasks, etc. -- simply state what the thing is: "The valid names", not "Return the valid names".
  • For functions/methods that exist mainly to produce and return a value, it's ok to omit the :return: docstring item if the docstring's first line starts with "Return ...". In some places, having both is useful, but see the previous bullet for cases when neither is necessary.

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.

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 looks great!

I like the idea of reflecting the nature of the method/function/property in the way we describe it. It's pretty consistent with naming methods/variables etc based on their part of speech (noun vs verb).

src/uwtools/config/formats/yaml.py Show resolved Hide resolved
src/uwtools/scheduler.py Show resolved Hide resolved
@maddenp-noaa maddenp-noaa merged commit 0ae1b49 into ufs-community:main Aug 21, 2024
2 checks passed
@maddenp-noaa maddenp-noaa deleted the docstring-cleanup branch August 21, 2024 22:44
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.

5 participants