Skip to content

Commit ef9ed53

Browse files
author
Martin O'Hanlon
committed
added alias
1 parent 773cb32 commit ef9ed53

2 files changed

Lines changed: 12 additions & 6 deletions

File tree

docs/api.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ Motor
6464
:inherited-members:
6565
:members:
6666

67-
Robot
68-
-----
67+
Robot / Rover
68+
-------------
6969

7070
.. autoclass:: Robot
7171
:show-inheritance:
@@ -102,16 +102,16 @@ Switch
102102
:inherited-members:
103103
:members:
104104

105-
Potentiometer
106-
-------------
105+
Potentiometer / Pot
106+
-------------------
107107

108108
.. autoclass:: Potentiometer
109109
:show-inheritance:
110110
:inherited-members:
111111
:members:
112112

113-
TemperatureSensor
114-
-----------------
113+
TemperatureSensor / TempSensor / Thermistor
114+
-------------------------------------------
115115

116116
.. autoclass:: TemperatureSensor
117117
:show-inheritance:

picozero/picozero.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1239,6 +1239,8 @@ class Robot:
12391239
"""
12401240
Represent a generic dual-motor robot / rover / buggy.
12411241
1242+
Alias for :class:`Rover`
1243+
12421244
This class is constructed with two tuples representing the forward and
12431245
backward pins of the left and right controllers respectively. For example,
12441246
if the left motor's controller is connected to pins 12 and 13, while the
@@ -1696,6 +1698,8 @@ class Potentiometer(AnalogInputDevice):
16961698
Represents a Potentiometer which outputs with a variable voltage
16971699
between 0 and 3.3V.
16981700
1701+
Alias for :class:`Pot`.
1702+
16991703
:param int pin:
17001704
The pin that the device is connected to.
17011705
@@ -1725,6 +1729,8 @@ class TemperatureSensor(AnalogInputDevice):
17251729
can be converted to a temperature using a `conversion` function passed as a
17261730
parameter.
17271731
1732+
Alias for :class:`Thermistor` and :class:`TempSensor`.
1733+
17281734
:param int pin:
17291735
The pin that the device is connected to.
17301736

0 commit comments

Comments
 (0)