Model documentation needs reviewing (Trac #19)

[sasview-bot]

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.

Migrated from http://trac.sasview.org/ticket/19

{
    "status": "closed",
    "changetime": "2016-12-07T13:33:47",
    "_ts": "2016-12-07 13:33:47.238230+00:00",
    "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.",
    "reporter": "ajjackson",
    "cc": "",
    "resolution": "fixed",
    "workpackage": "SasView Documentation",
    "time": "2012-03-29T10:42:35",
    "component": "SasView",
    "summary": "Model documentation needs reviewing",
    "priority": "blocker",
    "keywords": "",
    "milestone": "SasView 4.0.0",
    "owner": "smk78",
    "type": "defect"
}

[butlerpd]

Trac update at 2012/03/29 21:59:49: butlerpd changed milestone from "" to "SansView 2.2"

[butlerpd]

Trac update at 2012/12/05 14:37:47: butlerpd changed milestone from "SasView 2.2" to "SasView 3.0.0"

[butlerpd]

Trac update at 2012/12/05 15:00:41:

• butlerpd changed component from "SansView" to "SasView"
• butlerpd changed owner from "" to ""

[sasview-bot]

Trac update at 2013/09/24 11:37:53:

• Peter Parker changed _comment0 from:

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

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

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 [http://sourceforge.net/p/sasview/code/6794 #6794].

to:

1380022697873003

• Peter Parker commented:

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 [http://sourceforge.net/p/sasview/code/6794 http://trac.sasview.org/ticket/6794].

[butlerpd]

Trac update at 2013/09/24 11:37:53: butler changed _comment1 from:

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 [http://sourceforge.net/p/sasview/code/6794 #6794].

to:

1457297468818611

[butlerpd]

Trac update at 2013/10/01 20:27:19: butler changed milestone from "SasView 3.0.0" to "SasView Next Release"

[sasview-bot]

Trac update at 2013/11/26 15:45:21: Peter Parker commented:

Richard Heenan made some suggestions for changes to the CoreShellCylinder Model documentation. These changes were made under revision [https://sourceforge.net/p/sasview/code/6828/ http://trac.sasview.org/ticket/6828].

[sasview-bot]

Trac update at 2014/01/06 15:49:42: Peter Parker commented:

Sphere Model documentation amended again, under revision [http://sourceforge.net/p/sasview/code/6845/ http://trac.sasview.org/ticket/6845].

[ajj]

Trac update at 2015/01/14 12:46:58: ajj changed workpackage from "" to "SasView Documentation"

[butlerpd]

Trac update at 2015/02/01 23:25:00:

• butler changed _comment0 from "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." to "1457146445134715"
• butler commented:

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.

• butler changed milestone from "SasView Next Release +1" to "SasView 3.1"

[butlerpd]

Trac update at 2015/03/10 15:40:20:

• butler commented:

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

• butler changed milestone from "SasView 3.1" to "SasView Next Release +1"

[butlerpd]

Trac update at 2015/08/14 19:49:13: butler changed milestone from "SasView Next Release +1" to "SasView 4.0.0"

[butlerpd]

Trac update at 2016/03/05 02:55:51: butler commented:

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

[butlerpd]

Trac update at 2016/03/05 03:02:27: butler changed priority from "major" to "blocker"

[butlerpd]

Trac update at 2016/03/06 20:56:05:

• butler commented:

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.

• butler changed owner from "" to "smk78"
• butler changed status from "new" to "assigned"

[butlerpd]

Trac update at 2016/09/05 01:58:22:

• butler commented:

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.

• butler changed resolution from "" to "fixed"
• butler changed status from "assigned" to "closed"

[sasview-bot]

Trac update at 2016/12/07 13:33:47: GitHub [email protected] commented:

In changeset 9300bfa:

#!CommitTicketReference repository="sasview" revision="9300bfaf72c2791ade4cf282bbb78890fb79c49c"
Merge pull request #248 from SasView/ticket-772

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