Skip to content

Fre make create_compile documentation and pylint updates pt.1#789

Open
singhd789 wants to merge 15 commits intoNOAA-GFDL:mainfrom
singhd789:fre-make-compile-doc
Open

Fre make create_compile documentation and pylint updates pt.1#789
singhd789 wants to merge 15 commits intoNOAA-GFDL:mainfrom
singhd789:fre-make-compile-doc

Conversation

@singhd789
Copy link
Contributor

@singhd789 singhd789 commented Mar 19, 2026

Describe your changes

  • addressed pylint messages (fixing snake_case variables)
  • update documentation in create_compile.py

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
Copy link

codecov bot commented Mar 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.23%. Comparing base (a17b3f0) to head (e3afa70).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #789      +/-   ##
==========================================
- Coverage   84.24%   84.23%   -0.02%     
==========================================
  Files          71       71              
  Lines        4984     4980       -4     
==========================================
- Hits         4199     4195       -4     
  Misses        785      785              
Flag Coverage Δ
unittests 84.23% <100.00%> (-0.02%) ⬇️

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

Files with missing lines Coverage Δ
fre/make/create_compile_script.py 97.87% <100.00%> (-0.17%) ⬇️

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 a17b3f0...e3afa70. 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 Update some documentation for fre make create_compile Fre make create_compile documentation updates Mar 20, 2026
@singhd789 singhd789 changed the title Fre make create_compile documentation updates Fre make create_compile documentation updates pt.1 Mar 20, 2026
@singhd789 singhd789 changed the title Fre make create_compile documentation updates pt.1 Fre make create_compile documentation and pylint updates pt.1 Mar 20, 2026
@singhd789 singhd789 marked this pull request as ready for review March 20, 2026 16:16
Dana Singh and others added 4 commits March 24, 2026 10:22
Updated documentation in create_compile_script.py to include details about the compile.sh script steps.
Updated parameter description for makejobs to clarify usage.
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.

2 participants