Skip to content

Update doc strings for list subtools - #959

Open
singhd789 wants to merge 1 commit into
NOAA-GFDL:mainfrom
singhd789:955.update-fre-list
Open

Update doc strings for list subtools#959
singhd789 wants to merge 1 commit into
NOAA-GFDL:mainfrom
singhd789:955.update-fre-list

Conversation

@singhd789

Copy link
Copy Markdown
Contributor

Describe your changes

Update documentation for fre list subtools to fit the format for the fre-cli chatbot

Issue ticket number and link (if applicable)

Starts #955

Checklist before requesting a review

  • I ran my code
  • I tried to make my code readable
  • I tried to comment my code
  • I wrote a new test, if applicable
  • I wrote new instructions/documentation, if applicable
  • I ran pytest and inspected it's output
  • I ran pylint and attempted to implement some of it's feedback
  • No print statements; all user-facing info uses logging module

Note: If you are a code maintainer updating the tag or releasing a new fre-cli version, please use the release_procedure.md template. To quickly use this template, open a new pull request, choose your branch, and add ?template=release_procedure.md to the end of the url.

@codecov

codecov Bot commented Jul 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.09%. Comparing base (e24a5d8) to head (49c22d4).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #959   +/-   ##
=======================================
  Coverage   82.09%   82.09%           
=======================================
  Files          67       67           
  Lines        3736     3736           
=======================================
  Hits         3067     3067           
  Misses        669      669           
Flag Coverage Δ
unittests 82.09% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
fre/list_/list_experiments_script.py 100.00% <ø> (ø)
fre/list_/list_platforms_script.py 100.00% <ø> (ø)
fre/list_/list_pp_components_script.py 95.65% <ø> (ø)

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e24a5d8...49c22d4. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@singhd789 singhd789 changed the title #955 update doc strings for list subtools Update doc strings for list subtools Jul 28, 2026
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.

1 participant