Skip to content

Putting fre catalog docstrings into plain sentences #905

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.

Sign up for GitHub

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
Ciheim wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Putting fre catalog docstrings into plain sentences #905

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
929816a
Rewrite catalog CLI docstrings
Copilot Jun 3, 2026
21be7ce
Revert validate docstring
Copilot Jun 3, 2026
bc4487c
Merge pull request #5 from Ciheim/copilot/convert-fre-catalog-docstrings
Ciheim Jun 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions fre/catalog/frecatalog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
'''
entry point for fre catalog subcommands
'''
"""This module defines the ``fre catalog`` CLI commands."""
Copy link
Copy Markdown
Contributor

@mlee03 mlee03 Jun 3, 2026

Choose a reason for hiding this comment

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

Will the definition of a catalog and more detailed descriptions of the click options be coming soon? 😁


import click

Expand All @@ -11,7 +9,7 @@

@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."""
Copy link
Copy Markdown
Contributor

@mlee03 mlee03 Jun 3, 2026

Choose a reason for hiding this comment

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

this -> catalog_cli?




Expand All @@ -38,7 +36,7 @@ def build(context, input_path = None, output_path = None, config = None, filter_
filter_freq = None, filter_chunk = None, verbose = False, overwrite = False,
append = False, slow = False, strict = False):
# pylint: disable=unused-argument
""" - Generate .csv and .json files for catalog """
"""Build catalog CSV and JSON files from the provided input data."""
context.forward(gen_intake_gfdl.create_catalog_cli)

@catalog_cli.command()
Expand All @@ -65,5 +63,5 @@ def validate(context, json_path, json_template_path, vocab, proper_generation, t
help = 'Merged catalog')
@click.pass_context
def merge(context, input, output):
""" - Merge two or more more catalogs into one """
"""Merge two or more catalogs into one catalog file."""
context.invoke(combine_cats.combine_cats, inputfiles=input, output_path=output)
Loading