Skip to content

Commit ffbb306

Browse files
committed
Add help to compile; make it visible in CLI help
1 parent b05951c commit ffbb306

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

paths_cli/commands/compile.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,18 @@ def register_installed_plugins():
6868

6969
@click.command(
7070
'compile',
71+
short_help="compile a description of OPS objects into a database",
7172
)
7273
@click.argument('input_file')
7374
@OUTPUT_FILE.clicked(required=True)
7475
def compile_(input_file, output_file):
76+
"""Compile JSON or YAML description of OPS objects into a database.
77+
78+
INPUT_FILE is a JSON or YAML file that describes OPS simulation
79+
objects (e.g., MD engines, state volumes, etc.). The output will be an
80+
OPS database containing those objects, which can be used as the input to
81+
many other CLI subcommands.
82+
"""
7583
loader = select_loader(input_file)
7684
with open(input_file, mode='r') as f:
7785
dct = loader(f)
@@ -87,7 +95,7 @@ def compile_(input_file, output_file):
8795

8896
PLUGIN = OPSCommandPlugin(
8997
command=compile_,
90-
section="Debug",
98+
section="Miscellaneous",
9199
requires_ops=(1, 0),
92100
requires_cli=(0, 3)
93101
)

0 commit comments

Comments
 (0)