Changeset 3d164b9 in sasview for src/sas/sasgui/perspectives/fitting/media/plugin.rst

Timestamp:

Sep 21, 2016 9:53:55 AM (8 years ago)

Author:

smk78

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

6e0c7b2

Parents:

7d94915

Message:

Under review - minor changes

File:

• src/sas/sasgui/perspectives/fitting/media/plugin.rst (modified) (5 diffs)

src/sas/sasgui/perspectives/fitting/media/plugin.rst

@@ -32 +32 @@
 `model marketplace <http://marketplace.sasview.org/>`_.
 
-The builtin modules are available in the *sasmodels-data/models* subdirectory
-of the sasview distribution.  On Windows, this will be something like
-*C:\Program Files (x86)\SasView\models*.  On MacOSX, these will be within
+The built-in modules are available in the *sasmodels-data\\models* subdirectory
+of the sasview installation folder.  On Windows, this will be something like
+*C:\\Program Files (x86)\\SasView\\sasmodels-data.  On MacOSX, these will be within
 the application bundle as
 */Applications/SasView 4.0.app/Contents/Resources/sasmodels-data/models*.
@@ -41 +41 @@
 ^^^^^^^^^^^^^^^^^^^^^^
 
-In the *~/.sasview/plugin_models* directory, copy the appropriate files
+In the *~\\.sasview\\plugin_models* directory, copy the appropriate files
 (using the examples above as templates) to mymodel.py (and mymodel.c, etc)
 as required, where "mymodel" is the name for the model you are creating.
@@ -48 +48 @@
 
 - No capitalization and thus no CamelCase.
-- If necessary use underscore to separate (i.e. barbell not BarBell or
+- If necessary use underscore to separate words (i.e. barbell not BarBell or
   broad_peak not BroadPeak)
-- Don't include “model” in the name (i.e. barbell not BarBellModel)
+- Do not include “model” in the name (i.e. barbell not BarBellModel)
 
 
@@ -85 +85 @@
    - this is ReStructuredText enclosed between the r""" and """ delimiters
      at the top of the *.py* file
+   - what you write here is abstracted into the help documentation
 
 - a **definition** of the model:
@@ -107 +108 @@
    - the *.py* file should also contain a comment identifying *who*
      converted/created the model file
+
+Models that do not conform to these requirements will *never* be incorporated 
+into the built-in library.
 
 More complete documentation for the sasmodels package can be found at