Opened 10 years ago

Closed 5 years ago

Last modified 5 years ago

#19 closed defect (fixed)

Model documentation needs reviewing

Reported by: ajjackson Owned by: smk78
Priority: blocker Milestone: SasView 4.0.0
Component: SasView Keywords:
Cc: Work Package: SasView Documentation

Description

The documentation for each model needs reviewing for correctness and completeness. E.g. the core-shell ellipsoid model has a picture of an ellipsoid, but not a core-shell one.

Change History (16)

comment:1 Changed 10 years ago by butlerpd

  • Milestone set to SansView 2.2

comment:2 Changed 9 years ago by butlerpd

  • Milestone changed from SasView 2.2 to SasView 3.0.0

comment:3 Changed 9 years ago by butlerpd

  • Component changed from SansView to SasView

comment:4 Changed 8 years ago by Peter Parker

Steve King and I reviewed the documentation for the following models:

  • DAB Model
  • Sphere Model
  • Mass Fractal Model
  • CorrLength Model
  • BroadPeak Model

Changed documentation where necessary so that it better matched what was going on in the code.

Added a "[Date] - Reviewed by [Reviewers]" comment to the end of each section.

Changes made under revision #6794.

Last edited 6 years ago by butler (previous) (diff)

comment:5 Changed 8 years ago by butler

  • Milestone changed from SasView 3.0.0 to SasView Next Release

comment:6 Changed 8 years ago by Peter Parker

Richard Heenan made some suggestions for changes to the CoreShellCylinder? Model documentation. These changes were made under revision #6828.

comment:7 Changed 8 years ago by Peter Parker

Sphere Model documentation amended again, under revision #6845.

comment:8 Changed 7 years ago by ajj

  • Work Package set to SasView Documentation

comment:9 Changed 7 years ago by butler

  • Milestone changed from SasView Next Release +1 to SasView 3.1

Structure of model documentation should be formalized to include author and date of initial implementation in SasView, of most recent change, and name of a reviewer/tester and date of "validation" For release 3.1 we could leave some as unknown or author = ported from NIST IGOR or some such.

Last edited 6 years ago by butler (previous) (diff)

comment:10 Changed 7 years ago by butler

  • Milestone changed from SasView 3.1 to SasView Next Release +1

Important but not critical to release so moving to next release+1

comment:11 Changed 6 years ago by butler

  • Milestone changed from SasView Next Release +1 to SasView 4.0.0

comment:12 Changed 6 years ago by butler

changing to blocker as this is one of the 6 primary tasks listed in the Roadmap for this release

comment:13 Changed 6 years ago by butler

  • Priority changed from major to blocker

comment:14 Changed 6 years ago by butler

  • Owner set to smk78
  • Status changed from new to assigned

This task is "embarrassingly parallel" and each model can be reviewed by a different person. In practice probably only a handful of people who can actually do this? Suggest that the assigned person is responsible for seeing that things get done? Probably start by making a table as we did for conversions that people can use to claim and then check as done? Also ONLY CONVERTED models documentation should be addressed/looked at.

Also make sure to add the "Last reviewed on: date by: reviewer name" section at the bottom of each.

comment:15 Changed 5 years ago by butler

  • Resolution set to fixed
  • Status changed from assigned to closed

This has essentially been done and as a large and vague umbrella is no longer useful. All existing models should now have had a thorough review including first pass at some consistency in presentation, all equations fixed and checked against the logic of code, text edited for legibility, and all parameters, their defaults and output plot are now all autogenerated. Only thing remaining I believe are

  • ensure standardized nomenclature (affects documentation in that name changes will need to be reflected here.
  • ensure all documentation follows standard format and includes the ref section and reviewer section.

Will open these as separate tickets and close this one now.

comment:16 Changed 5 years ago by GitHub <noreply@…>

In 9300bfaf72c2791ade4cf282bbb78890fb79c49c/sasview:

Merge pull request #19 from SasView?/ticket-772

Added descriptions of special functions located in sasmodels/../lib to p…

Note: See TracTickets for help on using tickets.