Skip to content

docs: fre/tests documentation on the command-line tests #597

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

cwhitlock-NOAA
Copy link
Collaborator

Describe your changes

A couple lines describing the command-line tests in each of the fre/tests tests.

Issue ticket number and link (if applicable)

Relates to issue #507 - documentation for the fre command-line tests

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

@cwhitlock-NOAA cwhitlock-NOAA self-assigned this Aug 13, 2025
Copy link

codecov bot commented Aug 13, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.07%. Comparing base (152774a) to head (ea983a6).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #597   +/-   ##
=======================================
  Coverage   70.07%   70.07%           
=======================================
  Files          63       63           
  Lines        4170     4170           
=======================================
  Hits         2922     2922           
  Misses       1248     1248           
Flag Coverage Δ
unittests 70.07% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

@ilaflott ilaflott linked an issue Aug 15, 2025 that may be closed by this pull request
12 tasks
@ilaflott ilaflott added the documentation Improvements or additions to documentation label Aug 15, 2025
@ilaflott ilaflott self-requested a review August 15, 2025 14:26
@@ -3,6 +3,16 @@

from fre import fre

"""
Copy link
Member

Choose a reason for hiding this comment

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

this should be at the top i think, replacing the meager place-holder docstrings at L1

Copy link
Member

@ilaflott ilaflott left a comment

Choose a reason for hiding this comment

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

move the doc-strings to the top and i can approve/merge

@@ -10,6 +10,16 @@

from fre import fre

"""
Copy link
Member

Choose a reason for hiding this comment

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

samethought...

@@ -4,6 +4,16 @@

from fre import fre

"""
Copy link
Member

Choose a reason for hiding this comment

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

etc...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: fre/tests
2 participants