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

Documentation needed #33

Open
bhbraswell opened this issue May 11, 2015 · 5 comments
Open

Documentation needed #33

bhbraswell opened this issue May 11, 2015 · 5 comments

Comments

@bhbraswell
Copy link
Member

Though I project, process, and inventory are already generally well understood, I think we need a single sentence explanation for each of the gips_ command line commands.

gips_archive, gips_fda, gips_info, gips_inventory, gips_mosaic, gips_project, gips_stats, gips_tiles, gips_copytiles, gips_gclass, gips___init__, gips_mask, gips_process, gips_regression, gips_tclass, gips_warptiles.

Where to put it? In a "gips_help" command? Or just in the repo.

@matthewhanson
Copy link
Member

Each util has help that will give a one liner.

Also the documentation should have a list of included utilities.

@matthewhanson
Copy link
Member

Also, I think some of those utilities are from older versions and were not cleaned from the system.

@mcorbiere
Copy link

I don't see a one liner in the help options for any of the utilities?

Is the documentation you're referring to the scripts.rst file in the docs folder on here? If so, it only has two of the utilities described, but it looks like it will be very helpful when it's complete.

And yes, I guess a lot of those are leftover (gips_mosaic issue) - we'll have to do some cleaning.

@matthewhanson
Copy link
Member

I guess the description of the util doesn't show up in help.

Yes, there is the start of documentation, the intention was that it would use github pages (and would show up at gips.github.io)

@ircwaves
Copy link
Member

ircwaves commented Nov 9, 2015

There is also a start in gips/doc/scripts.rst. Should definitely be expanded, but it is a start.

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

4 participants