Opened 4 weeks ago

Closed 40 hours ago

#1148 closed defect (fixed)

Documentation for S(Q) models need updating

Reported by: butler Owned by: butler
Priority: critical Milestone: SasView 4.2.0
Component: SasView Keywords:
Cc: Work Package: SasView Bug Fixing

Description

The model documentations auto generates some of the documentation such as the example plot (using default parameters) and adds the scale and background parameters to the table.

For S(Q) however there is no scale and background term when using the model (a change from previous versions I believe) but the documentation still generates those leading to some user confusion.

Change History (3)

comment:1 Changed 2 weeks ago by butler

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

comment:2 Changed 4 days ago by pkienzle

Fixed in sasmodels. Close ticket when verified.

comment:3 Changed 40 hours ago by butler

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

Fixed by commit6e45516f19370dc8d3a8ff3fa00959f6e27d9e19. Tested that it does as advertized. Was pushed directly to master rather than through a PR as was a rather simple fix to documentation and sasmodels cannot yet have builds for testing. Basically create a conditional block in generate.py so that "COMMON" parameters (i.e. those auto generated for every mode) are not added to the parameter table in the generated docs for structure factor models (but is for all others).

Now closing ticket

Note: See TracTickets for help on using tickets.