Update Selection documentation to use scope

klarh · Jun 25, 2020 · 0efdd9d · 0efdd9d
1 parent 8b6453e
commit 0efdd9d
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/flowws_analysis/Selection.py b/flowws_analysis/Selection.py
@@ -69,8 +69,9 @@ class Selection(flowws.Stage):
     """Filter the set of displayed particles manually or by specified criteria.
 
     This module removes particles by filtering all per-particle
-    quantities according to a series of criteria, such as
-    `potential_energy < -0.5`.
+    quantities according to a series of criteria. These criteria use
+    the "state" scope that is used to pass data between modules, such
+    as `scope["potential_energy"] < -0.5`.
 
     When used interactively with vispy scenes, selections can be made
     with the mouse, or particles on the convex hull of a droplet can