Opened 8 years ago
Closed 6 years ago
#646 closed task (fixed)
Check all model documentation for standardization
Reported by: | butler | Owned by: | butler |
---|---|---|---|
Priority: | major | Milestone: | SasView 4.3.0 |
Component: | sasmodels | Keywords: | |
Cc: | Work Package: | SasView Documentation |
Description
In particular ensure that sections are in standard order, all equation images are removed and that reference and reviewed by sections are included.
Change History (13)
comment:1 Changed 8 years ago by butler
- Milestone changed from SasView 4.0.0 to SasView 4.1.0
comment:2 Changed 8 years ago by butler
comment:3 Changed 8 years ago by butler
- Owner set to butler
- Status changed from new to assigned
comment:4 Changed 8 years ago by butler
comment:5 Changed 8 years ago by butler
comment:6 Changed 8 years ago by butler
comment:7 Changed 8 years ago by butler
comment:8 Changed 8 years ago by butler
comment:9 Changed 8 years ago by ajj
- Milestone changed from SasView 4.1.0 to SasView 4.2.0
comment:10 Changed 7 years ago by butler
comment:11 Changed 7 years ago by butler
- Milestone changed from SasView 4.2.0 to SasView 4.3.0
comment:12 Changed 6 years ago by smk78
In addressing #883, #1187, and #1240 I have been through every single P(q) and S(q) model file and:
- corrected typos where spotted
- changed wording/layout in places (for consistency, standardisation, etc)
- added some additional references
- ensured all files have Authorship & Verification sections (even if some fields are empty!)
- added links to the source code on GitHub
- checked all models have equations (except where noted in the tickets above)
- removed a legacy png formula
I now consider that the look and content of the model documentation is in pretty good shape and that this ticket can now be closed. Specific issues should now be raised in specific tickets.
comment:13 Changed 6 years ago by smk78
- Resolution set to fixed
- Status changed from assigned to closed
Note: See
TracTickets for help on using
tickets.
Not critical for 4.0 - documentation is OK if variable. Will move this to 4.1 so we can release 4.0 now.