Changeset 2802 for trunk/GSASIIplot.py

Timestamp:

Apr 23, 2017 9:30:38 PM (7 years ago)

Author:

toby

Message:

updates for doc build

File:

• trunk/GSASIIplot.py (modified) (5 diffs)

trunk/GSASIIplot.py

@@ -22 +22 @@
 import wx.glcanvas
 import matplotlib as mpl
-try:  # code not found in readthedocs
-    import matplotlib.collections as mplC
-except:
-    print('matplotlib.collections not present') 
+import matplotlib.collections as mplC
 import mpl_toolkits.mplot3d.axes3d as mp3d
 import GSASIIpath
@@ -1206 +1203 @@
     Note that plotting information will be found in:
        G2frame.PatternId (contains the tree item for the current histogram)
+       
        G2frame.PickId (contains the actual selected tree item (can be child of histogram)
+
        G2frame.HKL (used for tool tip display of hkl for selected phase reflection list)
     '''
@@ -2842 +2841 @@
     :param str Title: title for plot
     :param bool lines: = True if lines desired for XY plot; XY2 always plotted as lines
-    :param list of str names: legend names for each XY plot
-    :param list of str names2: legend names for each XY2 plot
-    :param lists of vertical line x-positions list; can be one for each XY
-    :return nothing
+    :param list names: legend names for each XY plot as list a of str values
+    :param list names2: legend names for each XY2 plot as list a of str values
+    :param list vertLines: lists of vertical line x-positions; can be one for each XY 
+    :returns: nothing
     
     '''
@@ -2964 +2963 @@
     :param bool newPlot: =True if new plot is to be made
     :param str Title: title for plot
-    :return nothing
+    :returns: nothing
     
     '''
@@ -4332 +4331 @@
     Called from a menu command (GSASIIimgGUI) or from OnImPlotKeyPress. 
     Variable G2frame.MaskKey contains a single letter ('f' or 'p', etc.) that
-      determines what type of mask is created.    
+    determines what type of mask is created.    
 
     :param wx.Frame G2frame: The main GSAS-II tree "window"