summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/pyb.Switch.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/pyb.Switch.rst')
-rw-r--r--docs/library/pyb.Switch.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/library/pyb.Switch.rst b/docs/library/pyb.Switch.rst
index daaed19420..bc62b6eee9 100644
--- a/docs/library/pyb.Switch.rst
+++ b/docs/library/pyb.Switch.rst
@@ -1,3 +1,5 @@
+.. currentmodule:: pyb
+
class Switch -- switch object
=============================
@@ -27,11 +29,12 @@ Constructors
Methods
-------
-.. method:: switch()
+.. method:: Switch.__call__()
- Return the switch state: ``True`` if pressed down, ``False`` otherwise.
+ Call switch object directly to get its state: ``True`` if pressed down,
+ ``False`` otherwise.
-.. method:: switch.callback(fun)
+.. method:: Switch.callback(fun)
Register the given function to be called when the switch is pressed down.
If ``fun`` is ``None``, then it disables the callback.