diff options
| author | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2016-06-08 16:21:28 +0300 |
|---|---|---|
| committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2016-06-08 16:21:28 +0300 |
| commit | a384a5313013d8ffda4db0e509cf798a080b3526 (patch) | |
| tree | c1b87be77f0a3a68fc5a55880bf9de8af3b90b87 /docs/library/pyb.Switch.rst | |
| parent | 585aafc27eb7fa8fe660e3eeaa29bf8d7ab99213 (diff) | |
| download | micropython-a384a5313013d8ffda4db0e509cf798a080b3526.tar.gz micropython-a384a5313013d8ffda4db0e509cf798a080b3526.zip | |
docs/pyb.*: Use proper class case in method headers.
Class designator will be used as is in indexes, so must match actual class
name.
Diffstat (limited to 'docs/library/pyb.Switch.rst')
| -rw-r--r-- | docs/library/pyb.Switch.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/library/pyb.Switch.rst b/docs/library/pyb.Switch.rst index a9aef4e2ec..bc62b6eee9 100644 --- a/docs/library/pyb.Switch.rst +++ b/docs/library/pyb.Switch.rst @@ -29,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. |