Skip to content

Commit 48bd295

Browse files
committed
Fix up docs for things that have been moved
1 parent 7471eda commit 48bd295

File tree

4 files changed

+11
-8
lines changed

4 files changed

+11
-8
lines changed

docs/for_core/cli.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,13 @@ the CLI:
8181

8282
* ``contents``: list all the named objects in an OPS storage, organized by
8383
store (type); this is extremely useful to get the name of an object to use
84-
as command-line input to one of the simulation scripts
84+
85+
8586
.. * ``strip-snapshots``: create a copy of the input storage file with the
8687
details (coordinates/velocities) of all snapshots removed; this allows you
8788
to make a much smaller copy (with results of CVs) to copy back to a local
8889
computer for analysis
90+
8991
* ``append`` : add an object from once OPS storage into another one; this is
9092
useful for getting everything into a single file before running a
9193
simulation

docs/full_cli.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ currently gives all commands alphabetically, without regard to section. In
99
general, this is not yet well-organized; contributions to improve that would
1010
be appreciated.
1111

12-
.. click:: paths_cli.cli:OPS_CLI
12+
.. click:: paths_cli.cli:main
1313
:prog: openpathsampling
1414
:show-nested:

docs/sphinx-helpers/make_param_table.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
import click
1313

1414
from paths_cli import parameters
15+
from paths_cli import param_core
1516

1617
TableEntry = collections.namedtuple("TableEntry",
1718
"param flags get_args help")
@@ -20,7 +21,7 @@ def is_click_decorator(thing):
2021
return getattr(thing, '__module__', None) == 'click.decorators'
2122

2223
def is_parameter(thing):
23-
return (isinstance(thing, parameters.AbstractLoader)
24+
return (isinstance(thing, param_core.AbstractLoader)
2425
or is_click_decorator(thing))
2526

2627
def rst_wrap(code):
@@ -33,18 +34,18 @@ def flags_help(click_decorator):
3334
return flags, help_
3435

3536
def get_args(parameter):
36-
if isinstance(parameter, parameters.StorageLoader):
37+
if isinstance(parameter, param_core.StorageLoader):
3738
return "``name``"
38-
elif isinstance(parameter, (parameters.OPSStorageLoadNames,
39-
parameters.OPSStorageLoadSingle)):
39+
elif isinstance(parameter, (param_core.OPSStorageLoadNames,
40+
param_core.OPSStorageLoadSingle)):
4041
return "``storage``, ``name``"
4142
elif is_click_decorator(parameter):
4243
return "No ``get`` function"
4344
else:
4445
return "Unknown"
4546

4647
def get_click_decorator(thing):
47-
if isinstance(thing, parameters.AbstractLoader):
48+
if isinstance(thing, param_core.AbstractLoader):
4849
return thing.param.clicked()
4950
elif is_click_decorator(thing):
5051
return thing

paths_cli/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,4 +146,4 @@ def main(log):
146146
logger.debug("About to run command") # TODO: maybe log invocation?
147147

148148
if __name__ == '__main__': # no-cov
149-
cli()
149+
main()

0 commit comments

Comments
 (0)