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

Encryption docs are missing from cli help #59

Open
machawk1 opened this issue Dec 9, 2016 · 2 comments
Open

Encryption docs are missing from cli help #59

machawk1 opened this issue Dec 9, 2016 · 2 comments

Comments

@machawk1
Copy link
Member

machawk1 commented Dec 9, 2016

ipwb -h index invokes the indexer's help contents via argparse. The newly added encryption feature invoked via ipwb -e index (warcPath) is not included in the "optional arguments" section when ipwb -h index is run.

Despite this, ipwb -e index DOES show the flag under usage but not documentation is available. Check the argparse code to see if something is missing from this sub-parsers definition.

@machawk1 machawk1 added the bug label Dec 9, 2016
@machawk1 machawk1 added this to the 1.X milestone Dec 9, 2016
@machawk1
Copy link
Member Author

machawk1 commented Dec 9, 2016

-h AFTER index shows the description. Not sure why ipwb -h index does not. It might have to do with the argparse hierarchy used.

➜  ipwb git:(master) ipwb index   
usage: ipwb [-h] [-e] index <warcPath>
ipwb: error: too few arguments
➜  ipwb git:(master) ipwb index -h
usage: ipwb [-h] [-e] index <warcPath>

Index a WARC file for replay in ipwb

positional arguments:
  index <warcPath>  Path to a WARC[.gz] file

optional arguments:
  -h, --help        show this help message and exit
  -e                Encrypt WARC content prior to disseminating to IPFS
➜  ipwb git:(master)

@machawk1
Copy link
Member Author

machawk1 commented Dec 9, 2016

ipwb -h foo invokes the primary argparse instance. The secondary parser look to require the secondary command, e.g., ipwb index -h foo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant