summaryrefslogtreecommitdiff
path: root/docs/library/machine.Pin.rst
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-06-08 01:33:49 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-06-08 01:33:49 +0300
commit7d7243f44c68c5c1bfeba160a1650174c744722f (patch)
treebec296a71da5412f7e74ad06de8709696b027422 /docs/library/machine.Pin.rst
parent93968bd6fb15d1d49e0c2e4a2d412250cc653057 (diff)
docs/machine.*: 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/machine.Pin.rst')
-rw-r--r--docs/library/machine.Pin.rst26
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/library/machine.Pin.rst b/docs/library/machine.Pin.rst
index 773d9ed0d..f672abe30 100644
--- a/docs/library/machine.Pin.rst
+++ b/docs/library/machine.Pin.rst
@@ -61,14 +61,14 @@ Constructors
.. class:: machine.Pin(id, ...)
Create a new Pin object associated with the id. If additional arguments are given,
- they are used to initialise the pin. See :meth:`pin.init`.
+ they are used to initialise the pin. See :meth:`Pin.init`.
Methods
-------
.. only:: port_wipy
- .. method:: pin.init(mode, pull, \*, drive, alt)
+ .. method:: Pin.init(mode, pull, \*, drive, alt)
Initialise the pin:
@@ -98,13 +98,13 @@ Methods
Returns: ``None``.
- .. method:: pin.id()
+ .. method:: Pin.id()
Get the pin id.
.. only:: port_esp8266
- .. method:: pin.init(mode, pull=None, \*, value)
+ .. method:: Pin.init(mode, pull=None, \*, value)
Initialise the pin:
@@ -121,7 +121,7 @@ Methods
- if `value` is given then it is the output value to set the pin
if it is in output mode.
-.. method:: pin.value([value])
+.. method:: Pin.value([value])
Get or set the digital logic level of the pin:
@@ -133,9 +133,9 @@ Methods
.. method:: pin([value])
Pin objects are callable. The call method provides a (fast) shortcut to set and get the value of the pin.
- See :func:`pin.value` for more details.
+ See :func:`Pin.value` for more details.
-.. method:: pin.alt_list()
+.. method:: Pin.alt_list()
Returns a list of the alternate functions supported by the pin. List items are
a tuple of the form: ``('ALT_FUN_NAME', ALT_FUN_INDEX)``
@@ -144,23 +144,23 @@ Methods
.. only:: port_wipy
- .. method:: pin.toggle()
+ .. method:: Pin.toggle()
Toggle the value of the pin.
- .. method:: pin.mode([mode])
+ .. method:: Pin.mode([mode])
Get or set the pin mode.
- .. method:: pin.pull([pull])
+ .. method:: Pin.pull([pull])
Get or set the pin pull.
- .. method:: pin.drive([drive])
+ .. method:: Pin.drive([drive])
Get or set the pin drive strength.
- .. method:: pin.irq(\*, trigger, priority=1, handler=None, wake=None)
+ .. method:: Pin.irq(\*, trigger, priority=1, handler=None, wake=None)
Create a callback to be triggered when the input level at the pin changes.
@@ -194,7 +194,7 @@ Methods
.. only:: port_esp8266
- .. method:: pin.irq(\*, trigger, handler=None)
+ .. method:: Pin.irq(\*, trigger, handler=None)
Create a callback to be triggered when the input level at the pin changes.