From 929816a898bf1388e03fbb0969b70b7d15d57d1a Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 3 Jun 2026 19:09:17 +0000 Subject: [PATCH 1/2] Rewrite catalog CLI docstrings --- fre/catalog/frecatalog.py | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/fre/catalog/frecatalog.py b/fre/catalog/frecatalog.py index 64f8ecb24..c7418be19 100644 --- a/fre/catalog/frecatalog.py +++ b/fre/catalog/frecatalog.py @@ -1,6 +1,4 @@ -''' -entry point for fre catalog subcommands -''' +"""This module defines the ``fre catalog`` CLI commands.""" import click @@ -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.""" @@ -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() @@ -53,9 +51,7 @@ def build(context, input_path = None, output_path = None, config = None, filter_ @click.pass_context def validate(context, json_path, json_template_path, vocab, proper_generation, test_failure): # pylint: disable=unused-argument - """ - Validate catalogs against controlled vocabulary as provided by particular JSON schemas - per vocabulary type (vocabulary validation) OR Validate a catalog against catalog schema - template (proper generation checking) """ + """Validate a catalog against vocabulary rules or a catalog schema template.""" context.forward(compval.main) @catalog_cli.command() @@ -65,5 +61,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) From 21be7ce06e0fe86d3bc95e0106ddca512949e25c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 3 Jun 2026 19:15:18 +0000 Subject: [PATCH 2/2] Revert validate docstring --- fre/catalog/frecatalog.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/fre/catalog/frecatalog.py b/fre/catalog/frecatalog.py index c7418be19..bf27844e2 100644 --- a/fre/catalog/frecatalog.py +++ b/fre/catalog/frecatalog.py @@ -51,7 +51,9 @@ def build(context, input_path = None, output_path = None, config = None, filter_ @click.pass_context def validate(context, json_path, json_template_path, vocab, proper_generation, test_failure): # pylint: disable=unused-argument - """Validate a catalog against vocabulary rules or a catalog schema template.""" + """ - Validate catalogs against controlled vocabulary as provided by particular JSON schemas + per vocabulary type (vocabulary validation) OR Validate a catalog against catalog schema + template (proper generation checking) """ context.forward(compval.main) @catalog_cli.command()