Skip to content

Commit 05686f2

Browse files
committed
update docstrings/--help info
1 parent 118e685 commit 05686f2

File tree

2 files changed

+3
-9
lines changed

2 files changed

+3
-9
lines changed

src/virtualship/cli/commands.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ def init(path, from_mfp):
6868
)
6969
def plan(path):
7070
"""
71-
Launch UI to help build schedule and ship config files.
71+
Launch UI to help build expedition configuration (YAML) file.
7272
7373
Should you encounter any issues with using this tool, please report an issue describing the problem to the VirtualShip issue tracker at: https://github.com/OceanParcels/virtualship/issues"
7474
"""
@@ -82,5 +82,5 @@ def plan(path):
8282
type=click.Path(exists=True, file_okay=False, dir_okay=True, readable=True),
8383
)
8484
def run(path):
85-
"""Run the expedition."""
85+
"""Execute the expedition simulations."""
8686
_run(Path(path))
Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1 @@
1-
"""Everything for simulating an expedition."""
2-
3-
from .do_expedition import do_expedition
4-
5-
__all__ = [
6-
"do_expedition",
7-
]
1+
"""Simulating an expedition."""

0 commit comments

Comments
 (0)