Add formatting to Copier/Linker/MakeDirs class docstrings for better API docs #601
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maddenp-noaa
requested review from
NaureenBharwaniNOAA,
christinaholtNOAA,
elcarpenterNOAA,
fgabelmannjr,
WeirAE and
Byrnetp
as code owners
NaureenBharwaniNOAA
approved these changes
Sep 3, 2024
christinaholtNOAA
approved these changes
Sep 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Synopsis
We previously exposed the
Copier,Linker, andMakeDirsclasses fromuwtools.fsvia the API, but the docstrings for those classes didn't get RST formatting added. This corrects that: Compare the current version (as of this writing)Copierdocs to the PR version.I also thought that the current API page is too long, so reduced its depth.
Type
Impact
Checklist