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.

Sign up for GitHub

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

Jump to bottom

UW-443 #361

Merged
merged 26 commits into from
Dec 13, 2023
Merged

UW-443 #361

merged 26 commits into from
Dec 13, 2023

Conversation

maddenp-noaa
Copy link
Contributor

@maddenp-noaa maddenp-noaa commented Dec 12, 2023 •
edited
Loading

Description

Generate API HTML documentation for uwtools.api.* modules. Add API docstrings.

Built PR docs are 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 Dec 12, 2023
@maddenp-noaa maddenp-noaa changed the base branch from develop to doc-update December 12, 2023 21:36
maddenp-noaa
maddenp-noaa commented Dec 12, 2023
View reviewed changes
docs/README.md Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
docs/sections/contributor_guide/developer_setup.rst Show resolved Hide resolved
src/uwtools/api/rocoto.py Show resolved Hide resolved
src/uwtools/api/rocoto.py Show resolved Hide resolved
src/uwtools/cli.py Show resolved Hide resolved
src/uwtools/api/forecast.py Show resolved Hide resolved
src/uwtools/api/config.py Outdated Show resolved Hide resolved
@maddenp-noaa maddenp-noaa marked this pull request as ready for review December 12, 2023 22:53
christinaholtNOAA
christinaholtNOAA approved these changes Dec 12, 2023
View reviewed changes
Copy link
Contributor

@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. Just one question about terminology.

docs/install-deps Show resolved Hide resolved
src/uwtools/api/config.py Outdated Show resolved Hide resolved
src/uwtools/api/config.py Outdated Show resolved Hide resolved
src/uwtools/api/forecast.py Show resolved Hide resolved
src/uwtools/api/template.py Outdated Show resolved Hide resolved
WeirAE
WeirAE approved these changes Dec 13, 2023
View reviewed changes
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.

Looks great, this will help a lot!

@maddenp-noaa maddenp-noaa merged commit c04e051 into ufs-community:doc-update Dec 13, 2023
1 check passed
@maddenp-noaa maddenp-noaa deleted the UW-443 branch December 13, 2023 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christinaholtNOAA christinaholtNOAA christinaholtNOAA approved these changes

@WeirAE WeirAE WeirAE approved these changes

@jprestop jprestop Awaiting requested review from jprestop

@NaureenBharwaniNOAA NaureenBharwaniNOAA Awaiting requested review from NaureenBharwaniNOAA

@elcarpenterNOAA elcarpenterNOAA Awaiting requested review from elcarpenterNOAA

@fgabelmannjr fgabelmannjr Awaiting requested review from fgabelmannjr

Assignees

@maddenp-noaa maddenp-noaa

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@maddenp-noaa @christinaholtNOAA @WeirAE