Opened 3 years ago

Last modified 8 weeks ago

#528 new enhancement

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

Reported by: butler Owned by:
Priority: major Milestone: SasView Next Release +1
Component: SasView Keywords:
Cc: Work Package: SasView Documentation

Description (last modified by butler)

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


Change History (4)

comment:1 Changed 3 years ago by butler

  • Description modified (diff)

comment:2 Changed 8 weeks ago by smk78

Opinions sought on Slack channel Sasview #general…

comment:3 Changed 8 weeks ago by smk78

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"?

comment:4 Changed 8 weeks ago by smk78

  • Summary changed from Short Description to What should we do with the (short) model description?
Note: See TracTickets for help on using tickets.