Skip to content

adding in an rst linter#796

Open
laurenchilutti wants to merge 9 commits into
NOAA-GFDL:mainfrom
laurenchilutti:rstlint
Open

adding in an rst linter#796
laurenchilutti wants to merge 9 commits into
NOAA-GFDL:mainfrom
laurenchilutti:rstlint

Conversation

@laurenchilutti

@laurenchilutti laurenchilutti commented Mar 25, 2026

Copy link
Copy Markdown
Member

Describe your changes

Issue ticket number and link (if applicable)

This PR fixes #810

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 Mar 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.09%. Comparing base (196e168) to head (a2a6827).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #796      +/-   ##
==========================================
+ Coverage   82.03%   82.09%   +0.05%     
==========================================
  Files          67       67              
  Lines        3736     3736              
==========================================
+ Hits         3065     3067       +2     
+ Misses        671      669       -2     
Flag Coverage Δ
unittests 82.09% <ø> (+0.05%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1 file with indirect coverage changes


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 196e168...a2a6827. Read the comment docs.

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

Comment thread .github/workflows/rst_lint.yml Outdated
Comment thread .github/workflows/rst_lint.yml Outdated
@laurenchilutti

Copy link
Copy Markdown
Member Author

@ilaflott Qhat did you change in the last commit? I can't tell

@ilaflott

Copy link
Copy Markdown
Member

@ilaflott Qhat did you change in the last commit? I can't tell

i updated your branch via rebase to integrate recent changes addressing testing failures in fre.cmor- your PRs checks had those same failures

@laurenchilutti

Copy link
Copy Markdown
Member Author

Thanks!

@laurenchilutti

Copy link
Copy Markdown
Member Author

@underwoo @ilaflott Please give it another review - acknowledging that the contributing guide for documentation needs to be updated, and the rst lint action fails (because the rst code is not up to par yet). I will use AI to fix the code next before we merge this PR.

@laurenchilutti laurenchilutti requested a review from ilaflott June 23, 2026 19:34

@ilaflott ilaflott left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

works! thank you. ponder optimizations as you feel necessary

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this could actually be even more minimal, avoiding cloning CatalogBuilder-

steps:
      - name: Code Checkout
        uses: actions/checkout@v4
        
      - name: Prepare Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'
          cache: 'pip'
          
      - name: Install doc8
        run: pip install doc8
        
      - name: Lint RST files
        working-directory: ./fre-cli
        run: doc8 *

Removed external catalogbuilder checkout and installation steps. Added doc8 installation for RST linting.
Removed working-directory for Python requirements installation.
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.

rst linter

3 participants