Putting fre catalog docstrings into plain sentences#905
Open
Ciheim wants to merge 3 commits into
Open
Conversation
Clarify `fre catalog` docstrings while preserving `validate` wording
mlee03
suggested changes
Jun 3, 2026
| @click.group(help=click.style(" - catalog subcommands", fg=(64,94,213))) | ||
| def catalog_cli(): | ||
| ''' entry point for click into fre catalog cli calls ''' | ||
| """This command group exposes the ``fre catalog`` subcommands.""" |
| ''' | ||
| entry point for fre catalog subcommands | ||
| ''' | ||
| """This module defines the ``fre catalog`` CLI commands.""" |
Contributor
There was a problem hiding this comment.
Will the definition of a catalog and more detailed descriptions of the click options be coming soon? 😁
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #905 +/- ##
=======================================
Coverage 84.36% 84.36%
=======================================
Files 71 71
Lines 5003 5003
=======================================
Hits 4221 4221
Misses 782 782
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe your changes
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
Note: If you are a code maintainer updating the tag or releasing a new fre-cli version, please use the
release_procedure.mdtemplate. To quickly use this template, open a new pull request, choose your branch, and add?template=release_procedure.mdto the end of the url.