Opened 10 years ago
Last modified 8 years ago
#422 closed task
Enhance help documentation — at Initial Version
| Reported by: | smk78 | Owned by: | smk78 |
|---|---|---|---|
| Priority: | critical | Milestone: | SasView 4.1.0 |
| Component: | SasView | Keywords: | |
| Cc: | Work Package: | SasView Documentation |
Description
The Sphinx help docs for Release 3.1 represent a porting of the pre-
existing HTML help docs to ReSTructured text.
Some restructuring has been conducted. Some (obvious!) equation errors
have been corrected. Some 'missing' content has been added.
The next steps are:
- checking that the documentation actually reflects the current functionality of the program!
- updating existing screenshots to match the current functionality of the program
- adding additional screenshots
- carefully and critically checking the model documentation which is known to contain many errors! The model documentation currently resides in model_functions.rst but will be moved to individual models as the 'sansmodels' upgrade proceeds. Those converting models should not assume that the model documentation they are copying is necessarily accurate. Also see Ticket #19.
Note: See
TracTickets for help on using
tickets.
