#59

APS-USAXS · Jan 24, 2019 · a02d352 · a02d352
1 parent 53757ca
commit a02d352
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/profile_bluesky/startup/43-procedures.py b/profile_bluesky/startup/43-procedures.py
@@ -22,7 +22,14 @@ def insertScanFilters():
 
 
 def confirm_instrument_mode(mode_name):
-    """True if instrument is in the named mode"""
+    """
+    True if instrument is in the named mode
+    
+    Parameter
+    
+    mode_name (str) :
+        One of the strings defined in ``UsaxsSaxsModes``
+    """
     expected_mode = UsaxsSaxsModes[mode_name]
     return terms.SAXS.UsaxsSaxsMode.value == expected_mode