Opened 3 years ago

Closed 6 months ago

Last modified 6 months ago

#668 closed defect (fixed)

Update plugin model documentation and testing

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

Description

Paraphrased from PaulK:

In sasview/src/sas/sasgui/perspectives/fitting/media/plugins.rst :

1) In the section "Test Your New Model" only the first paragraph currently applies to the release version. The run_one() and compare.main() functions are only implemented in the developer version.

When these functions are implemented in the release version we might want to consider providing menu bar options for "Compare", "Compare Random" and "Show Help" in addition to the complicated command line access described?

2) Pylint is not currently shipped with the release version so the sections "Clean Lint" or "Check the Docs" are tagged as "Developer Version Only". Obviously this will need updating if the situation changes.

Change History (3)

comment:1 Changed 6 months ago by butler

Has this ticket become obsolete?

comment:2 Changed 6 months ago by smk78

  • Owner set to smk78
  • Resolution set to fixed
  • Status changed from new to closed

In c94ab04e18bfbb17455ae74d31a271d9cdb0f3b4/sasmodels:

Clarified Testing section of plugin.rst. Closes #668

comment:3 Changed 6 months ago by smk78

To address 1) a clarification has been added to the Testing section of plugin.rst. The subsequent suggestion for GUI buttons are now the subject of #1260.

The situation regarding 2) has not changed and the relevant sections of plugin.rst are ok as is.

This ticket is now obsolete so can be closed.

Note: See TracTickets for help on using tickets.