Skip to content

Commit

Permalink
Fix \* in explicit constructor declarations
Browse files Browse the repository at this point in the history 
It appears one of the changes from Sphinx 1.x to 3.x was to remove the
necessity for escaping asterisks in constructor overrides.

Unfortunately this makes editing the source in anything with reST syntax
highlighting rather difficult but at least this should be a temporary
problem; the only reason we have the constructor overrides is because we
can't declare the constructors "properly" as the * keyword-only args
syntax doesn't exist in Python 2.x. When we drop support in the next
major release we can remove all the constructor overrides in the docs.
  • Loading branch information
@waveform80
waveform80 committed Mar 11, 2021
1 parent 6012942 commit 379bb23
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 60 deletions.
62 changes: 31 additions & 31 deletions docs/api_boards.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,28 +61,28 @@ named after. All classes in this section are concrete (not abstract).
LEDBoard
--------

.. autoclass:: LEDBoard(\*pins, pwm=False, active_high=True, initial_value=False, pin_factory=None, \*\*named_pins)
.. autoclass:: LEDBoard(*pins, pwm=False, active_high=True, initial_value=False, pin_factory=None, **named_pins)
:members: on, off, blink, pulse, toggle


LEDBarGraph
-----------

.. autoclass:: LEDBarGraph(\*pins, pwm=False, active_high=True, initial_value=0, pin_factory=None)
.. autoclass:: LEDBarGraph(*pins, pwm=False, active_high=True, initial_value=0, pin_factory=None)
:members: value, source, values, lit_count


LEDCharDisplay
--------------

.. autoclass:: LEDCharDisplay(\*pins, dp=None, font=None, pwm=False, active_high=True, initial_value=' ', pin_factory=None)
.. autoclass:: LEDCharDisplay(*pins, dp=None, font=None, pwm=False, active_high=True, initial_value=' ', pin_factory=None)
:members: value, font


LEDMultiCharDisplay
-------------------

.. autoclass:: LEDMultiCharDisplay(char, \*pins, active_high=True, initial_value=None, pin_factory=None)
.. autoclass:: LEDMultiCharDisplay(char, *pins, active_high=True, initial_value=None, pin_factory=None)
:members: value, plex_delay


Expand All @@ -95,168 +95,168 @@ LEDCharFont
ButtonBoard
-----------

.. autoclass:: ButtonBoard(\*pins, pull_up=True, active_state=None, bounce_time=None, hold_time=1, hold_repeat=False, pin_factory=None, \*\*named_pins)
.. autoclass:: ButtonBoard(*pins, pull_up=True, active_state=None, bounce_time=None, hold_time=1, hold_repeat=False, pin_factory=None, **named_pins)
:members: wait_for_press, wait_for_release, is_pressed, pressed_time, when_pressed, when_released, value


TrafficLights
-------------

.. autoclass:: TrafficLights(red, amber, green, \*, yellow=None, pwm=False, initial_value=False, pin_factory=None)
.. autoclass:: TrafficLights(red, amber, green, *, yellow=None, pwm=False, initial_value=False, pin_factory=None)
:members:


TrafficLightsBuzzer
-------------------

.. autoclass:: TrafficLightsBuzzer(lights, buzzer, button, \*, pin_factory=None)
.. autoclass:: TrafficLightsBuzzer(lights, buzzer, button, *, pin_factory=None)
:members:


PiHutXmasTree
-------------

.. autoclass:: PiHutXmasTree(\*, pwm=False, initial_value=False, pin_factory=None)
.. autoclass:: PiHutXmasTree(*, pwm=False, initial_value=False, pin_factory=None)
:members:


LedBorg
-------

.. autoclass:: LedBorg(\*, pwm=True, initial_value=(0, 0, 0), pin_factory=None)
.. autoclass:: LedBorg(*, pwm=True, initial_value=(0, 0, 0), pin_factory=None)
:members:


PiLiter
-------

.. autoclass:: PiLiter(\*, pwm=False, initial_value=False, pin_factory=None)
.. autoclass:: PiLiter(*, pwm=False, initial_value=False, pin_factory=None)
:members:


PiLiterBarGraph
---------------

.. autoclass:: PiLiterBarGraph(\*, pwm=False, initial_value=False, pin_factory=None)
.. autoclass:: PiLiterBarGraph(*, pwm=False, initial_value=False, pin_factory=None)
:members:


PiTraffic
---------

.. autoclass:: PiTraffic(\*, pwm=False, initial_value=False, pin_factory=None)
.. autoclass:: PiTraffic(*, pwm=False, initial_value=False, pin_factory=None)
:members:


PiStop
------

.. autoclass:: PiStop(location, \*, pwm=False, initial_value=False, pin_factory=None)
.. autoclass:: PiStop(location, *, pwm=False, initial_value=False, pin_factory=None)
:members:


FishDish
--------

.. autoclass:: FishDish(\*, pwm=False, pin_factory=None)
.. autoclass:: FishDish(*, pwm=False, pin_factory=None)
:members:


TrafficHat
----------

.. autoclass:: TrafficHat(\*, pwm=False, pin_factory=None)
.. autoclass:: TrafficHat(*, pwm=False, pin_factory=None)
:members:


TrafficpHat
-----------

.. autoclass:: TrafficpHat(\*, pwm=False, pin_factory=None)
.. autoclass:: TrafficpHat(*, pwm=False, pin_factory=None)
:members:


JamHat
------

.. autoclass:: JamHat(\*, pwm=False, pin_factory=None)
.. autoclass:: JamHat(*, pwm=False, pin_factory=None)
:members:


Pibrella
--------

.. autoclass:: Pibrella(\*, pwm=False, pin_factory=None)
.. autoclass:: Pibrella(*, pwm=False, pin_factory=None)
:members:


Robot
-----

.. autoclass:: Robot(left, right, \*, pwm=True, pin_factory=None)
.. autoclass:: Robot(left, right, *, pwm=True, pin_factory=None)
:members:


PhaseEnableRobot
----------------

.. autoclass:: PhaseEnableRobot(left, right, \*, pwm=True, pin_factory=None)
.. autoclass:: PhaseEnableRobot(left, right, *, pwm=True, pin_factory=None)
:members:


RyanteckRobot
-------------

.. autoclass:: RyanteckRobot(\*, pwm=True, pin_factory=None)
.. autoclass:: RyanteckRobot(*, pwm=True, pin_factory=None)
:members:


CamJamKitRobot
--------------

.. autoclass:: CamJamKitRobot(\*, pwm=True, pin_factory=None)
.. autoclass:: CamJamKitRobot(*, pwm=True, pin_factory=None)
:members:


PololuDRV8835Robot
------------------

.. autoclass:: PololuDRV8835Robot(\*, pwm=True, pin_factory=None)
.. autoclass:: PololuDRV8835Robot(*, pwm=True, pin_factory=None)
:members:


Energenie
---------

.. autoclass:: Energenie(socket, \*, initial_value=False, pin_factory=None)
.. autoclass:: Energenie(socket, *, initial_value=False, pin_factory=None)
:members: on, off, socket, value


StatusZero
----------

.. autoclass:: StatusZero(\*labels, pwm=False, active_high=True, initial_value=False, pin_factory=None)
.. autoclass:: StatusZero(*labels, pwm=False, active_high=True, initial_value=False, pin_factory=None)
:members:


StatusBoard
-----------

.. autoclass:: StatusBoard(\*labels, pwm=False, active_high=True, initial_value=False, pin_factory=None)
.. autoclass:: StatusBoard(*labels, pwm=False, active_high=True, initial_value=False, pin_factory=None)
:members:


SnowPi
------

.. autoclass:: SnowPi(\*, pwm=False, initial_value=False, pin_factory=None)
.. autoclass:: SnowPi(*, pwm=False, initial_value=False, pin_factory=None)
:members:


PumpkinPi
---------

.. autoclass:: PumpkinPi(\*, pwm=False, initial_value=False, pin_factory=None)
.. autoclass:: PumpkinPi(*, pwm=False, initial_value=False, pin_factory=None)
:members:


Expand All @@ -281,19 +281,19 @@ to construct classes for their own devices.
LEDCollection
-------------

.. autoclass:: LEDCollection(\*pins, pwm=False, active_high=True, initial_value=False, pin_factory=None, \*\*named_pins)
.. autoclass:: LEDCollection(*pins, pwm=False, active_high=True, initial_value=False, pin_factory=None, **named_pins)
:members:


CompositeOutputDevice
---------------------

.. autoclass:: CompositeOutputDevice(\*args, _order=None, pin_factory=None, \*\*kwargs)
.. autoclass:: CompositeOutputDevice(*args, _order=None, pin_factory=None, **kwargs)
:members:


CompositeDevice
---------------

.. autoclass:: CompositeDevice(\*args, _order=None, pin_factory=None, \*\*kwargs)
.. autoclass:: CompositeDevice(*args, _order=None, pin_factory=None, **kwargs)
:members:
2 changes: 1 addition & 1 deletion docs/api_generic.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ are represented in purple, while abstract classes are shaded lighter):
Device
======

.. autoclass:: Device(\*, pin_factory=None)
.. autoclass:: Device(*, pin_factory=None)
:members: close, closed, value, is_active, pin_factory


Expand Down
18 changes: 9 additions & 9 deletions docs/api_input.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,42 +54,42 @@ represent. All classes in this section are concrete (not abstract).
Button
------

.. autoclass:: Button(pin, \*, pull_up=True, active_state=None, bounce_time=None, hold_time=1, hold_repeat=False, pin_factory=None)
.. autoclass:: Button(pin, *, pull_up=True, active_state=None, bounce_time=None, hold_time=1, hold_repeat=False, pin_factory=None)
:members: wait_for_press, wait_for_release, pin, is_pressed, is_held, hold_time, held_time, hold_repeat, pull_up, when_pressed, when_released, when_held, value


LineSensor (TRCT5000)
---------------------

.. autoclass:: LineSensor(pin, \*, queue_len=5, sample_rate=100, threshold=0.5, partial=False, pin_factory=None)
.. autoclass:: LineSensor(pin, *, queue_len=5, sample_rate=100, threshold=0.5, partial=False, pin_factory=None)
:members: wait_for_line, wait_for_no_line, pin, line_detected, when_line, when_no_line, value


MotionSensor (D-SUN PIR)
------------------------

.. autoclass:: MotionSensor(pin, \*, queue_len=1, sample_rate=10, threshold=0.5, partial=False, pin_factory=None)
.. autoclass:: MotionSensor(pin, *, queue_len=1, sample_rate=10, threshold=0.5, partial=False, pin_factory=None)
:members: wait_for_motion, wait_for_no_motion, pin, motion_detected, when_motion, when_no_motion, value


LightSensor (LDR)
-----------------

.. autoclass:: LightSensor(pin, \*, queue_len=5, charge_time_limit=0.01, threshold=0.1, partial=False, pin_factory=None)
.. autoclass:: LightSensor(pin, *, queue_len=5, charge_time_limit=0.01, threshold=0.1, partial=False, pin_factory=None)
:members: wait_for_light, wait_for_dark, pin, light_detected, when_light, when_dark, value


DistanceSensor (HC-SR04)
------------------------

.. autoclass:: DistanceSensor(echo, trigger, \*, queue_len=30, max_distance=1, threshold_distance=0.3, partial=False, pin_factory=None)
.. autoclass:: DistanceSensor(echo, trigger, *, queue_len=30, max_distance=1, threshold_distance=0.3, partial=False, pin_factory=None)
:members: wait_for_in_range, wait_for_out_of_range, trigger, echo, when_in_range, when_out_of_range, max_distance, distance, threshold_distance, value


RotaryEncoder
-------------

.. autoclass:: RotaryEncoder(a, b, \*, bounce_time=None, max_steps=16, threshold_steps=(0, 0), wrap=False, pin_factory=None)
.. autoclass:: RotaryEncoder(a, b, *, bounce_time=None, max_steps=16, threshold_steps=(0, 0), wrap=False, pin_factory=None)
:members: wait_for_rotate, wait_for_rotate_clockwise, wait_for_rotate_counter_clockwise, when_rotated, when_rotated_clockwise, when_rotated_counter_clockwise, steps, value, max_steps, threshold_steps, wrap


Expand All @@ -110,21 +110,21 @@ to construct classes for their own devices.
DigitalInputDevice
------------------

.. autoclass:: DigitalInputDevice(pin, \*, pull_up=False, active_state=None, bounce_time=None, pin_factory=None)
.. autoclass:: DigitalInputDevice(pin, *, pull_up=False, active_state=None, bounce_time=None, pin_factory=None)
:members: wait_for_active, wait_for_inactive, when_activated, when_deactivated, active_time, inactive_time, value


SmoothedInputDevice
-------------------

.. autoclass:: SmoothedInputDevice(pin, \*, pull_up=False, active_state=None, threshold=0.5, queue_len=5, sample_wait=0.0, partial=False, pin_factory=None)
.. autoclass:: SmoothedInputDevice(pin, *, pull_up=False, active_state=None, threshold=0.5, queue_len=5, sample_wait=0.0, partial=False, pin_factory=None)
:members: is_active, value, threshold, partial, queue_len


InputDevice
-----------

.. autoclass:: InputDevice(pin, \*, pull_up=False, active_state=None, pin_factory=None)
.. autoclass:: InputDevice(pin, *, pull_up=False, active_state=None, pin_factory=None)
:members: pull_up, is_active, value


Expand Down
12 changes: 6 additions & 6 deletions docs/api_internal.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,35 +57,35 @@ named after. All classes in this section are concrete (not abstract).
TimeOfDay
---------

.. autoclass:: TimeOfDay(start_time, end_time, \*, utc=True, pin_factory=None)
.. autoclass:: TimeOfDay(start_time, end_time, *, utc=True, pin_factory=None)
:members: start_time, end_time, utc, value


PingServer
----------

.. autoclass:: PingServer(host, \*, pin_factory=None)
.. autoclass:: PingServer(host, *, pin_factory=None)
:members: host, value


CPUTemperature
--------------

.. autoclass:: CPUTemperature(sensor_file='/sys/class/thermal/thermal_zone0/temp', \*, min_temp=0.0, max_temp=100.0, threshold=80.0, pin_factory=None)
.. autoclass:: CPUTemperature(sensor_file='/sys/class/thermal/thermal_zone0/temp', *, min_temp=0.0, max_temp=100.0, threshold=80.0, pin_factory=None)
:members: temperature, value, is_active


LoadAverage
-----------

.. autoclass:: LoadAverage(load_average_file='/proc/loadavg', \*, min_load_average=0.0, max_load_average=1.0, threshold=0.8, minutes=5, pin_factory=None)
.. autoclass:: LoadAverage(load_average_file='/proc/loadavg', *, min_load_average=0.0, max_load_average=1.0, threshold=0.8, minutes=5, pin_factory=None)
:members: load_average, value, is_active


DiskUsage
---------

.. autoclass:: DiskUsage(filesystem='/', \*, threshold=90.0, pin_factory=None)
.. autoclass:: DiskUsage(filesystem='/', *, threshold=90.0, pin_factory=None)
:members: usage, value, is_active


Expand All @@ -106,4 +106,4 @@ to construct classes for their own devices.
InternalDevice
--------------

.. autoclass:: InternalDevice(\*, pin_factory=None)
.. autoclass:: InternalDevice(*, pin_factory=None)

0 comments on commit 379bb23

Please sign in to comment.