Reading-eScience-Centre / pycovjson

Create CovJSON files from common scientific data formats
BSD 3-Clause "New" or "Revised" License
11 stars 7 forks source link

CLI documentation unclear #22

Open letmaik opened 7 years ago

letmaik commented 7 years ago

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:

RileyWilliams commented 7 years ago

Thought I had already updated this, will fix now

lewismc commented 7 years ago

This can be resolved @letmaik @RileyWilliams

letmaik commented 7 years ago

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

lewismc commented 7 years ago

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