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

CLI documentation unclear #22

Open
letmaik opened this issue Oct 14, 2016 · 4 comments
Open

CLI documentation unclear #22

letmaik opened this issue Oct 14, 2016 · 4 comments

Comments

@letmaik
Copy link
Contributor

letmaik commented Oct 14, 2016

The README says:

$ python cli/convert.py -i *name of input file(NetCDF)* -o *name of output file* -v *variable* -r *range type* [-t] *tiled* [-s] *tile shape as list*

The first thing is that this should say $ pycovjson-convert ....

When I run the tool without arguments, it outputs:

usage: pycovjson-convert [-h] -i INPUTFILE [-o OUTPUTFILE] [-t]
                         [-s SHAPE [SHAPE ...]] [-v VARIABLE]

Three things:

  • Apparently there's no -r argument, I assume the README is outdated then.
  • The -t argument doesn't accept values, so what does *tiled* mean in the README description?
  • It's not clear to me how the -s argument should be used, an example would be good, especially considering the axis order.
  • The -v argument is not specified as mandatory in the usage output. When I leave it out I get a very nasty exception.
@RileyWilliams
Copy link
Collaborator

Thought I had already updated this, will fix now

@lewismc
Copy link
Contributor

lewismc commented Oct 18, 2016

This can be resolved @letmaik @RileyWilliams

@letmaik
Copy link
Contributor Author

letmaik commented Oct 19, 2016

Markdown is messed up in the pycovjson-viewer section. Also, *tiled* is still in.

@lewismc
Copy link
Contributor

lewismc commented Jun 15, 2017

@letmaik can you check if this is resolved? I think it is.

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

3 participants