update docstring

microsoft · May 9, 2022 · 1dfe134 · 1dfe134
1 parent a992554
commit 1dfe134
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/qcodes/instrument/base.py b/qcodes/instrument/base.py
@@ -340,11 +340,13 @@ def invalidate_cache(self) -> None:
         Calling this method will recursively mark the cache of all parameters
         on the instrument and any parameter on instrument modules as invalid.
 
-        This is useful if you have performed manual operations (e.g. using the frontpanel)
+        This is useful if you have performed manual operations
+        (e.g. using the frontpanel)
         which changes the state of the instrument outside QCoDeS.
 
-        This in turn means that the next snapshot of the instrument will trigger a (potentially slow)
-        reread of all parameters of the instrument.
+        This in turn means that the next snapshot of the instrument will trigger
+        a (potentially slow) reread of all parameters of the instrument if you pass
+        `update=None` to snapshot.
         """
         for parameter in self.parameters.values():
             parameter.cache.invalidate()