Changes between Version 46 and Version 47 of ModelConvInst

Timestamp:

Mar 16, 2016 5:42:32 AM (9 years ago)

Author:

smk78

Comment:

—

ModelConvInst

@@ -24 +24 @@
 
 The model interface definition is in the .py file.  This file contains:
-- **MODEL DOCUMENTATION**
+- **MODEL DOCUMENTATION** (also see [[Documentation Checks]])
 - **doc string**. The .py starts with an r (for raw) and three sets of quotes to start the doc string and ends with a second set of 3 quotes. This is where the FULL documentation for the model goes (to be picked up by Sphinx). Paste the model documentation from the appropriate section of model_functions.rst (found at [https://github.com/SasView/sasview/blob/master/src/sas/models/media/model_functions.rst src/sas/models/media/model_functions.rst]) here. DO NOT use the old html documentation. For example, for the !BarBellModel, search for !BarBellModel in the rst file then copy everything after the *2.x.x. !ModelNameModel!**. Then edit the result as follows:
  - the *2.x.x.x Model!** section with its brief description of the model becomes the model title; it feels odd that the documentation string does not start with name and brief description but it is automatically added by the model loader.