Changes between Version 4 and Version 5 of Documentation Checks

Timestamp:

Mar 16, 2016 5:24:52 AM (8 years ago)

Author:

smk78

Comment:

—

Documentation Checks

@@ -21 +21 @@
  - this will be auto-generated from the ''parameters'' in the ''.py'' file
 
- - model parameter names should be consistent between different models, so ''solvent_sld'', for example, should have exactly the same name in every model
  - ''scale'' and ''background'' are implicit to all models, they do not need to be added separately
-
- - new parameter names:
-  - radius = radius
-  - sld = scattering length density of particle
-  - solvent_sld = scattering length density of matrix
-  - regiona_sld = scattering length density of region a for a multi component model with several slds
-  - cor_length = correlation length
-  - exp = an exponent
-  - peak_pos = q_peak or q0, etc
-  - theta = axis_theta
-  - phi = axis_phi
-  - vol_frac = volume fraction of particle
-  - etc
+ - '''parameter names should follow the mathematical convention; eg, ''radius_core'' not ''core_radius'', or ''sld_solvent'' not ''solvent_sld''
+ - use ''python -m sasmodels.list_pars'' to see all the parameter names currently in use: ''re-use'' as many as possible!!!
+ - model parameter names should be consistent between different models, so ''sld_solvent'', for example, should have exactly the same name in every model
 
  - every parameter should have units (or the word ''None'')
@@ -77 +66 @@
  - the ''.py'' file should also contain a comment identifying ''who'' converted/created the model file
 
+This table indicates the status of documentation compliance.
 
 ||=!SasView name=||=sasmodels name=||= short_desc =||= param_table =||= long_desc =||= definition =||= formula =||= param_desc =||= plot =||= ref =||= attribution =||