Changeset 3253 for trunk/GSASIIscriptable.py

Timestamp:

Feb 1, 2018 10:15:35 AM (5 years ago)

Author:

toby

Message:

remove extraneous reload; improve scriptable docs

File:

• trunk/GSASIIscriptable.py (modified) (6 diffs)

trunk/GSASIIscriptable.py

@@ -2679 +2679 @@
 commandhelp["create"] = "creates a GSAS-II project, optionally adding histograms and/or phases"
 def create(args):
-    """The create subcommand. This creates a GSAS-II project, optionally adding histograms and/or phases::
+    """Implements the create command-line subcommand. This creates a GSAS-II project, optionally adding histograms and/or phases::
 
   usage: GSASIIscriptable.py create [-h] [-d HISTOGRAMS [HISTOGRAMS ...]]
@@ -2723 +2723 @@
 commandhelp["add"] = "adds histograms and/or phases to GSAS-II project"
 def add(args):
-    """The add subcommand. This adds histograms and/or phases to GSAS-II project::
+    """Implements the add command-line subcommand. This adds histograms and/or phases to GSAS-II project::
 
   usage: GSASIIscriptable.py add [-h] [-d HISTOGRAMS [HISTOGRAMS ...]]
@@ -2788 +2788 @@
 commandhelp["dump"] = "Shows the contents of a GSAS-II project"
 def dump(args):
-    """The dump subcommand shows the contents of a GSAS-II project::
+    """Implements the dump command-line subcommand, which shows the contents of a GSAS-II project::
 
        usage: GSASIIscriptable.py dump [-h] [-d] [-p] [-r] files [files ...]
@@ -2856 +2856 @@
 '''
 def refine(args):
-    """Conducts refinements on GSAS-II projects according to a JSON refinement dict::
+    """Implements the refine command-line subcommand:
+    conducts refinements on GSAS-II projects according to a JSON refinement dict::
     
   usage: GSASIIscriptable.py refine [-h] gpxfile [refinements]
@@ -2888 +2889 @@
 commandhelp["seqrefine"] = "Not implemented. Placeholder for eventual sequential refinement implementation"
 def seqrefine(args):
-    """The seqrefine subcommand"""
+    """Future implementation for the seqrefine command-line subcommand """
     raise NotImplementedError("seqrefine is not yet implemented")
 
@@ -2894 +2895 @@
 commandhelp["export"] = "Export phase as CIF"
 def export(args):
-    """The export subcommand: Exports phase as CIF::
+    """Implements the export command-line subcommand: Exports phase as CIF::
 
       usage: GSASIIscriptable.py export [-h] gpxfile phase exportfile