What should we do with the (short) model description? (Trac #528)

[butlerpd]

At Code Camp IV it was pointed out that something should be done about the "description" pop up that reads from the "short description" in the sasmodel. Two levels of questions were raised:

• Is it still useful (i.e. should we get rid of it)
• If it is useful could we replace with the autogenerated table of parameters

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

{
    "status": "new",
    "changetime": "2019-03-26T13:27:47",
    "_ts": "2019-03-26 13:27:47.047413+00:00",
    "description": "At Code Camp IV it was pointed out that something should be done about the \"description\" pop up that reads from the \"short description\" in the sasmodel. Two levels of questions were raised:\n\n* Is it still useful (i.e. should we get rid of it)\n* If it is useful could we replace with the autogenerated table of parameters\n ",
    "reporter": "butler",
    "cc": "",
    "resolution": "",
    "workpackage": "SasView Documentation",
    "time": "2016-03-17T14:17:02",
    "component": "SasView",
    "summary": "What should we do with the (short) model description?",
    "priority": "major",
    "keywords": "",
    "milestone": "SasView Next Release +1",
    "owner": "",
    "type": "enhancement"
}

[butlerpd]

Trac update at 2016/03/17 14:20:56: butler changed description from:

At Code Camp IV it was pointed out that something should be done about the "description" pop up that reads from the "short description" in the sasmodel. Two levels of questions were raised:

• Is it still useful (i.e. should we get rid of it
• If it is useful could we replace with the autogenerated table of parameters

to:

At Code Camp IV it was pointed out that something should be done about the "description" pop up that reads from the "short description" in the sasmodel. Two levels of questions were raised:

• Is it still useful (i.e. should we get rid of it)
• If it is useful could we replace with the autogenerated table of parameters

[smk78]

Trac update at 2019/03/26 12:50:39: smk78 commented:

Opinions sought on Slack channel Sasview #general...

[smk78]

Trac update at 2019/03/26 13:25:16: smk78 commented:

Something of a consensus that the short description is mostly obsolete EXCEPT in the case of sum|multi models and plugin models, where it is the only documentation a user can provide. Although if you don't add any text in the sum|multi description box !SasView generates a description for you!

Could some sort of custom model documentation for plugins be generated "on the fly"?

[smk78]

Trac update at 2019/03/26 13:27:47: smk78 changed summary from "Short Description" to "What should we do with the (short) model description?"