Opened 5 years ago

Closed 5 years ago

#1148 closed enhancement (fixed)

Documentation for S(Q) models need updating

Reported by: butler Owned by: butler
Priority: critical Milestone: SasView 4.3.0
Component: SasView Keywords:
Cc: Work Package: SasView Documentation


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 (6)

comment:1 Changed 5 years ago by butler

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

comment:2 Changed 5 years ago by pkienzle

Fixed in sasmodels. Close ticket when verified.

comment:3 Changed 5 years 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 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

comment:4 Changed 5 years ago by smk78

  • Milestone changed from SasView 4.2.0 to SasView 4.3.0
  • Resolution fixed deleted
  • Status changed from closed to reopened
  • Type changed from defect to enhancement
  • Work Package changed from SasView Bug Fixing to SasView Documentation

Re-opening this ticket as I just noticed that none of the S(Q) models actually describe the functions they are applying!

comment:5 Changed 5 years ago by pkienzle

The ticket description and possible the title need to be changed to reflect this new requirement.

comment:6 Changed 5 years ago by butler

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

Indeed this ticket was not about the lack of equation or other lack in the writeup but about the autogeneration doing something wrong. That was fixed in the commit listed. The title was probably not the best.

Going to reclose this ticket and open a new one as actually this is not a problem specific to SQ. I have found there are several models that do not have the equations listed …

Note: See TracTickets for help on using tickets.