Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the help message for install command #28

Merged
merged 2 commits into from Nov 6, 2019

Conversation

@515hikaru
Copy link
Contributor

515hikaru commented Nov 3, 2019

Before(Current)

$ pyflow help install

Install packages from `pyproject.toml`, `pyflow.lock`, or speficied ones. Example:

`pyflow install`: sync your installation with `pyproject.toml`, or `pyflow.lock` if it exists.
`pyflow install numpy scipy`: install `numpy` and `scipy`.

This description has no information about options or arguments. I changed it to display such information like any other command.

After

$ pyflow help install
pyflow-install 0.1.9
Install packages from `pyproject.toml`, or ones specified

USAGE:
    pyflow install [FLAGS] [packages]...

FLAGS:
    -d, --dev        Save package to your dev-dependencies section
    -h, --help       Prints help information
    -V, --version    Prints version information

ARGS:
    <packages>...    
@David-OConnor

This comment has been minimized.

Copy link
Owner

David-OConnor commented Nov 6, 2019

Nice find. Could you please modify this to include the detailed message too? I think this could be done by entering the whole message in the doc-comment (///) format you used.

@515hikaru

This comment has been minimized.

Copy link
Contributor Author

515hikaru commented Nov 6, 2019

Thank you for your review.
I left an existing message on doc-coment. How about this?

The output is as follows.

pyflow-install 0.1.9
Install packages from `pyproject.toml`, `pyflow.lock`, or speficied ones. Example:

`pyflow install`: sync your installation with `pyproject.toml`, or `pyflow.lock` if it exists.
`pyflow install numpy scipy`: install `numpy` and `scipy`.

USAGE:
    pyflow install [FLAGS] [packages]...

FLAGS:
    -d, --dev        Save package to your dev-dependencies section
    -h, --help       Prints help information
    -V, --version    Prints version information

ARGS:
    <packages>... 
@David-OConnor

This comment has been minimized.

Copy link
Owner

David-OConnor commented Nov 6, 2019

Good stuff!

@David-OConnor David-OConnor merged commit 1961fc7 into David-OConnor:master Nov 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.