Skip to content

Added command-line option explanations and usage examples for CLI scripts - #796

Merged
awwad merged 1 commit into
theupdateframework:developfrom
michizhou:develop
Nov 19, 2018
Merged

awwad merged 1 commit into
theupdateframework:developfrom
michizhou:develop

Conversation

@michizhou

Copy link
Copy Markdown
Contributor

Please fill in the fields below to submit a pull request. The more information
that is provided, the better.

Fixes issue #763:

Description of the changes being introduced by the pull request:
Updated the docstrings of the CLI script files repo.py and client.py with in-depth explanations of command-line options for the sake of completeness and in order to improve the user experience. Also included a few more concrete usage examples for command-line options in client.py.

Please verify and check that the pull request fulfills the following
requirements
:

  • The code follows the Code Style Guidelines
  • Tests have been added for the bug fix or new feature
  • Docs have been added for the bug fix or new feature

Signed-off-by: Michael Zhou <myz227@nyu.edu>
@michizhou michizhou changed the title Added command-line option explanations and usage examples Added command-line option explanations and usage examples for CLI scripts Nov 3, 2018
@awwad

awwad commented Nov 19, 2018

Copy link
Copy Markdown
Contributor

Thanks for the help! LGTM.

I'll leave 763 open, since repo.py still lacks docstrings for some of its functions.

@awwad
awwad merged commit ea22402 into theupdateframework:develop Nov 19, 2018
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.

2 participants