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

Fix command name and arguments in README #7

Merged
merged 1 commit into from
Mar 21, 2019

Conversation

rohanpm
Copy link
Member

@rohanpm rohanpm commented Mar 21, 2019

The command and some argument names were incorrect.

@rohanpm rohanpm requested a review from a team March 21, 2019 00:32
Copy link
Contributor

@alexandrevicenzi alexandrevicenzi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The arguments in the doc are wrong and some are missing, could you also update that?

The command and some argument names were incorrect.
@rohanpm rohanpm changed the title Fix command name in README Fix command name and arguments in README Mar 21, 2019
@rohanpm
Copy link
Member Author

rohanpm commented Mar 21, 2019

OK, I've fixed some wrong argument names too.

About the missing arguments, I don't want to add those, I don't think it should be required for the README to list every possible argument. What I'd rather do is, once the sphinx docs are working, try integrating https://sphinx-argparse.readthedocs.io/en/stable/ ... this generates docs using the help text defined in the argparser, so it's not necessary to duplicate the info.

@rbikar rbikar merged commit 1184c27 into release-engineering:master Mar 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants