ppenteado / ominas

Opensource Multi-INstrument Analysis Software
2 stars 8 forks source link

GRIM documentation #6

Open jnspitale opened 7 years ago

jnspitale commented 7 years ago

I have updated the GRIM documentation header. It's still far from complete, but every keyword is documented, and the overall functionality is better documented. One thing we'll need to figure out is GRIM's help system (see below), and how the headers for all of the individual menu options and cursor modes get incorporated into the OMINAS documentation system. I think this deserves special attention since grim is the primary tool that users will be interacting with. Basically, we need to look at what the GRIM documentation is going to look like in the documentation system since its spread out over numerous subroutines.

GRIM's current help menus simply display the documentation header for the selected menu option, each of which has a header associated with it in the code. Those headers had been extracted by the old documentation system, which we're not using anymore, so they are way out of date, and will never be updated under the new system. nv_help uses the same system for displaying documentation headers, so it also needs to be looked at.

jnspitale commented 7 years ago

A little more on this: basically, there just needs to be a place where the extracted headers can be found by grim and nv_help. Paulo, does the new system deposit those somewhere?

penteado-jpl commented 6 years ago

This issue was moved to nasa/ominas#4