Lerking/micropython
1
0
Fork 0
mirror of https://github.com/micropython/micropython.git synced 2026-01-06 20:20:14 +01:00
Code Issues Actions 52 Packages Projects Releases Wiki Activity

docs/pyb.*: Use proper class case in method headers.

Browse Source 
Class designator will be used as is in indexes, so must match actual class
name.
This commit is contained in:
Paul Sokolovsky
2016-06-08 16:21:28 +03:00
parent 585aafc27e
commit a384a53130
16 changed files with 108 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/library/pyb.Pin.rst
View File

@@ -104,7 +104,7 @@ Methods
.. only:: port_pyboard
.. method:: pin.init(mode, pull=Pin.PULL_NONE, af=-1)
.. method:: Pin.init(mode, pull=Pin.PULL_NONE, af=-1)
Initialise the pin:
@@ -128,7 +128,7 @@ Methods
Returns: ``None``.
.. method:: pin.value([value])
.. method:: Pin.value([value])
Get or set the digital logic level of the pin:
@@ -139,39 +139,39 @@ Methods
.. only:: port_pyboard
.. method:: pin.__str__()
.. method:: Pin.__str__()
Return a string describing the pin object.
.. method:: pin.af()
.. method:: Pin.af()
Returns the currently configured alternate-function of the pin. The
integer returned will match one of the allowed constants for the af
argument to the init function.
.. method:: pin.gpio()
.. method:: Pin.gpio()
Returns the base address of the GPIO block associated with this pin.
.. method:: pin.mode()
.. method:: Pin.mode()
Returns the currently configured mode of the pin. The integer returned
will match one of the allowed constants for the mode argument to the init
function.
.. method:: pin.name()
.. method:: Pin.name()
Get the pin name.
.. method:: pin.names()
.. method:: Pin.names()
Returns the cpu and board names for this pin.
.. method:: pin.pin()
.. method:: Pin.pin()
Get the pin number.
.. method:: pin.port()
.. method:: Pin.port()
Get the pin port.
@@ -179,7 +179,7 @@ Methods
Returns an array of alternate functions available for this pin.
.. method:: pin.pull()
.. method:: Pin.pull()
Returns the currently configured pull of the pin. The integer returned
will match one of the allowed constants for the pull argument to the init