Skip to content

Commit d02af45

Browse files
committed
Update documentation and CLI tool help
1 parent cc43bef commit d02af45

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

docs/xcetool.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ Options:
2626
- `-e`, `--environment` `FILE`:
2727
Conda environment file to use in Docker image.
2828
If no environment file is specified here or in the notebook,
29+
xcetool will look for a file called `environment.yml`
30+
in the notebook's directory. If all else fails,
2931
xcetool will try to reproduce the current environment
30-
as a last resort, but this is not recommended.
32+
as a last resort, but this is not guaranteed to succeed.
3133
- `-t`, `--tag` `TEXT`: Tag to apply to the Docker image.
3234
If not specified, a
3335
timestamp-based tag will be generated automatically.

xcengine/cli.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,9 @@ def image_cli():
117117
"--environment",
118118
type=click.Path(path_type=pathlib.Path, dir_okay=False, file_okay=True),
119119
help="Conda environment file to use in Docker image. "
120-
"If not specified, try to reproduce the current environment.",
120+
"If no environment file is specified here or in the notebook, and if "
121+
"there is no file named environment.yml in the notebook's directory, "
122+
"xcetool will try to reproduce the current environment."
121123
)
122124
@click.option(
123125
"-t",

0 commit comments

Comments
 (0)