Changeset 5104

Timestamp:

Nov 27, 2021 7:38:44 AM (2 years ago)

Author:

toby

Message:

fix misc. sphinx-docs formatting

Location:

trunk

Files:

• GSASIImapvars.py (modified) (1 diff)
• GSASIImath.py (modified) (1 diff)
• GSASIIobj.py (modified) (4 diffs)
• GSASIIplot.py (modified) (2 diffs)

trunk/GSASIImapvars.py

@@ -292 +292 @@
   data tree. Function 
   :func:`GSASIIseqGUI.UpdateSeqResults` displays the sequential results
-  table 
-also processes constraints. 
+  table also processes constraints. 
 
 TODO: Note that G2stIO.makeTwinFrConstr is called only in one place. It probably needs to be included in all of the above.

trunk/GSASIImath.py

@@ -2137 +2137 @@
 
     :returns: modeDict,posDict where modeDict contains pairs of mode values 
-    and mode s.u. values; posDict contains pairs of displacement values 
-    and their s.u. values.
+      and mode s.u. values; posDict contains pairs of displacement values 
+      and their s.u. values.
     '''
     ISO = Phase['ISODISTORT']

trunk/GSASIIobj.py

@@ -1131 +1131 @@
 
 Three typical examples:
+
     1) Bragg-Brentano laboratory diffractometer: Chi=0
     2) Debye-Scherrer counter detector; sample capillary axis perpendicular to diffraction plane: Chi=90
     3) Debye-Scherrer 2D area detector positioned directly behind sample; sample capillary axis horizontal; Chi=0
-            NB: The area detector azimuthal angle = 0 in horizontal plane to right as viewed from x-ray source & 90 at vertical "up" direction
+
+NB: The area detector azimuthal angle will equal 0 in horizontal plane to right as viewed from x-ray source and will equal 
+90 at vertical "up" direction.
             
 ISODISTORT implementation
@@ -1142 +1145 @@
 https://stokes.byu.edu/iso/isodistort_version5.6.1/isodistort.php
 [B. J. Campbell, H. T. Stokes, D. E. Tanner, and D. M. Hatch, "ISODISPLACE: An Internet Tool for Exploring Structural Distortions." 
- J. Appl. Cryst. 39, 607-614 (2006).] can be read into GSAS-II using import CIF. This will cause constraints to be established for 
+J. Appl. Cryst. 39, 607-614 (2006).] can be read into GSAS-II using import CIF. This will cause constraints to be established for 
 structural distortion modes read from the CIF. At present, of the five types of modes  only displacive(``_iso_displacivemode``...) 
 and occupancy (``_iso_occupancymode``...) are processed. Not yet processed: ``_iso_magneticmode``..., 
@@ -1169 +1172 @@
 corresponding :class:`GSASIIobj.G2VarObj` objects for each are placed in ``.Phase['ISODISTORT']['G2ModeList']``.
 [Use ``str(G2VarObj)`` to get the variable name from the G2VarObj object, but note that the phase number, *n*, for the prefix 
- "*n*::" cannot be determined as the phase number is not yet assigned.]
+"*n*::" cannot be determined as the phase number is not yet assigned.]
 
 Displacive modes are a bit complex in that they relate to delta displacements, relative to an offset value for each coordinate, 
@@ -2429 +2432 @@
 
         :returns: varname, explain, note, warnmsg (all str values) where:
+
           * varname is the parameter expressed as a string,
           * explain is blank unless there is a warning explanation about 

trunk/GSASIIplot.py

@@ -504 +504 @@
         :param str label: title of plot
         :param str Type: determines the type of plot that will be opened. 
+
           'mpl' for 2D graphs in matplotlib
           'ogl' for openGL
           '3d' for 3D plotting in matplotlib
+
         :param bool newImage: forces creation of a new graph for matplotlib
           plots only (defaults as True)
@@ -513 +515 @@
           which prevents use of this).
         :returns: new,plotNum,Page,Plot,limits where 
+
           * new: will be True if the tab was just created
           * plotNum: is the tab number