Skip to content

DOCUMENTATION: fre make refinement #891

Open
mlee03 wants to merge 8 commits into
NOAA-GFDL:mainfrom
mlee03:fremake-doc-predicate
Open

DOCUMENTATION: fre make refinement #891
mlee03 wants to merge 8 commits into
NOAA-GFDL:mainfrom
mlee03:fremake-doc-predicate

Conversation

@mlee03
Copy link
Copy Markdown
Contributor

@mlee03 mlee03 commented May 14, 2026

Describe your changes

This PR

  1. modifies the :param docstrings to be in predicate form. For example,
    :param variable random variable
    changed to
    :param variable. is a random variable
    This change will help when parsing the docstrings to create a vector database for the chatbot.

  2. added slightly more detailed information to current documentation with the help of AI coding assistant.

Issue ticket number and link (if applicable)

Fixes #XXX (replace XXX with the issue number and GitHub will autolink the PR to the issue)

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.

mlee03 and others added 3 commits May 14, 2026 09:31
@codecov
Copy link
Copy Markdown

codecov Bot commented May 14, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.36%. Comparing base (705f6cf) to head (0f0d4eb).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #891   +/-   ##
=======================================
  Coverage   84.36%   84.36%           
=======================================
  Files          71       71           
  Lines        5003     5003           
=======================================
  Hits         4221     4221           
  Misses        782      782           
Flag Coverage Δ
unittests 84.36% <ø> (ø)

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

Files with missing lines Coverage Δ
fre/make/create_checkout_script.py 97.46% <ø> (ø)
fre/make/create_compile_script.py 97.87% <ø> (ø)
fre/make/create_docker_script.py 100.00% <ø> (ø)
fre/make/create_makefile_script.py 97.67% <ø> (ø)
fre/make/fremake.py 95.58% <ø> (ø)
fre/make/make_helpers.py 100.00% <ø> (ø)
fre/make/run_fremake_script.py 97.95% <ø> (ø)

Continue to review full report in Codecov by Sentry.

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

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

@mlee03 mlee03 marked this pull request as ready for review May 18, 2026 17:21
@mlee03 mlee03 requested review from Ciheim, Copilot, laurenchilutti, meteorologist15, rem1776 and singhd789 and removed request for Copilot and singhd789 May 18, 2026 17:21
@mlee03
Copy link
Copy Markdown
Contributor Author

mlee03 commented May 18, 2026

I'm still editing the content, but it is open for review!

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