Documentation for OrthoEditProfile.

fsl/fsleyes/editor/editor.py

@@ -49,17 +49,20 @@ class Editor(props.HasProperties):
     to perform the second step.
 
     
-    .. note:: An important point to keep in mind is that whenever the
-              :attr:`.DisplayContext.selectedOverlay` property changes, the
-              ``Editor`` will discard the current :class:`.Selection`
-              instance, and create a new one, which matches the resolution of
-              the newly selected overlay (if the new overlay is not an
-              :class:`.Image`, a ``Selection`` object is not created).
-
-              I may change this behaviour in the future, as it is a potential
-              bug source. I will possibly change the structure so that
-              ``Editor`` instances are created/destroyed for individual
-              overlays.
+    .. warning:: An important point to keep in mind is that whenever the
+                 :attr:`.DisplayContext.selectedOverlay` property changes, the
+                 ``Editor`` will discard the current :class:`.Selection`
+                 instance, and create a new one, which matches the resolution
+                 of the newly selected overlay (if the new overlay is not an
+                 :class:`.Image`, a ``Selection`` object is not created).
+                 Therefore, it is probably a bad idea to store your own
+                 reference to the current ``Selection`` object - just use the
+                 :meth:`getSelection` method.
+
+                 I may change this behaviour in the future, as it is a
+                 potential bug source. I will possibly change the structure so
+                 that ``Editor`` instances are created/destroyed for
+                 individual overlays.
 
     
     Some convenience methods are also provided for working with selections:

fsl/fsleyes/editor/selection.py

@@ -304,11 +304,12 @@ class Selection(props.HasProperties):
                            be selected.
 
         :arg searchRadius: May be either a single value, or a sequence of
-                           three values - one for each axis. If provided,
-                           the search is limited to an ellipse, centred on
-                           the seed location, with the specified
-                           ``searchRadius`` (in voxels). If not provided,
-                           the search will cover the entire image space.
+                           three values - one for each axis. If provided, the
+                           search is limited to a sphere (in the voxel
+                           coordinate system), centred on the seed location,
+                           with the specified ``searchRadius`` (in voxels). If
+                           not provided, the search will cover the entire
+                           image space.
 
         :arg local:        If ``True``, a voxel will only be selected if it
                            is adjacent to an already selected voxel (using

fsl/fsleyes/profiles/orthoviewprofile.py

@@ -54,6 +54,7 @@ class OrthoViewProfile(profiles.Profile):
     ================ ========================================================
     """
 
+    
     def __init__(self,
                  viewPanel,
                  overlayList,