Skip to content

Commit e64e5fb

Browse files
sommersoftsommersoft
committed
Sphinx: switched to double literals (s) on most refs
1 parent 8515806 commit e64e5fb

File tree

2 files changed

+38
-38
lines changed

2 files changed

+38
-38
lines changed

‎adafruit_trellis/trellis.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ class TRELLIS:
7676
7777
:param ~busio.I2C i2c: The `busio.I2C` object to use. This is the only required parameter
7878
when using a single Trellis board.
79-
:param int address: The I2C address of the Trellis board you're using. Defaults to `0x70`
79+
:param int address: The I2C address of the Trellis board you're using. Defaults to ``0x70``
8080
which is the default address for Trellis boards. See Trellis product
8181
guide for using different/multiple I2C addresses.
8282
https://learn.adafruit.com/adafruit-trellis-diy-open-source-led-keypad
@@ -169,7 +169,7 @@ def show(self):
169169

170170
def led_on(self, x):
171171
"""
172-
Turns an LED on. Must call `[trellis].show()` afterwards to update the matrix.
172+
Turns an LED on. Must call ``trellis.show()`` afterwards to update the matrix.
173173
174174
:param int x: LED number (1-16) to turn on.
175175
"""
@@ -182,7 +182,7 @@ def led_on(self, x):
182182

183183
def led_off(self, x):
184184
"""
185-
Turns an LED off. Must call `[trellis].show()` to update the matrix.
185+
Turns an LED off. Must call ``trellis.show()`` to update the matrix.
186186
187187
:param int x: LED number (0-15) to turn off.
188188
"""

‎adafruit_trellis/trellis_set.py

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ class MATRIX(object):
5858
See Trellis product guide for using different/multiple I2C addresses.
5959
https://learn.adafruit.com/adafruit-trellis-diy-open-source-led-keypad
6060
61-
:param ~trellis.TRELLIS object: A list of `trellis.TRELLIS` objects to
61+
:param ~trellis.TRELLIS object: A list of ``trellis.TRELLIS`` objects to
6262
use in the matrix. Each object needs its
6363
own I2C address.
6464
@@ -131,10 +131,10 @@ def blink_rate(self, rate, *matrices):
131131
Set the blink rate.
132132
133133
:param int brightness: Range 0-3.
134-
:param ~trellis.TRELLIS object(s): list of `trellis.TRELLIS` objects
134+
:param ~trellis.TRELLIS object(s): list of ``trellis.TRELLIS`` objects
135135
you wish to change the blink rate
136136
of. Only required if you don't want
137-
to update ALL `trellis_set.MATRIX`
137+
to update ALL ``trellis_set.MATRIX``
138138
objects.
139139
140140
"""
@@ -150,7 +150,7 @@ def brightness(self, brightness, *matrices):
150150
Set the brightness.
151151
152152
:param int brightness: Range 0-15.
153-
:param ~trellis.TRELLIS object(s): list of `trellis.TRELLIS` objects
153+
:param ~trellis.TRELLIS object(s): list of ``trellis.TRELLIS`` objects
154154
you wish to change the brightness
155155
of. Only required if you don't want
156156
to update ALL `trellis_set.MATRIX`
@@ -167,7 +167,7 @@ def show(self, *matrices):
167167
"""
168168
Refresh the matrix and show the changes.
169169
170-
:param ~trellis.TRELLIS matrices: List of `trellis.TRELLIS` objects
170+
:param ~trellis.TRELLIS matrices: List of ``trellis.TRELLIS`` objects
171171
you wish refresh.
172172
Only required if you want to turn
173173
on an LED on a specific Trellis
@@ -183,16 +183,16 @@ def show(self, *matrices):
183183
def led_on(self, x, *matrices):
184184
"""
185185
Turn on the specified LED in the display buffer. Must call
186-
`[trellis].show()` afterwards to update the matrix.
186+
``trellis.show()`` afterwards to update the matrix.
187187
188188
:param int x: Number of LED you wish to turn on. When not including
189-
specific `trellis.TRELLIS` objects (`*matrices` param),
190-
the range of `x` is 0 to the maximum number of LEDs you
191-
have (4 Trellis boards: 0-63). When using `*matrices`,
192-
the range of `x` is 0-15 for the LED on each Trellis.
189+
specific ``trellis.TRELLIS`` objects (``*matrices`` param),
190+
the range of ``x`` is 0 to the maximum number of LEDs you
191+
have (4 Trellis boards: 0-63). When using ``*matrices``,
192+
the range of ``x`` is 0-15 for the LED on each Trellis.
193193
194-
:param ~trellis.TRELLIS matrices: List of `trellis.TRELLIS` objects
195-
you wish to turn on the LED `x`.
194+
:param ~trellis.TRELLIS matrices: List of ``trellis.TRELLIS`` objects
195+
you wish to turn on the LED ``x``.
196196
Only required if you want to turn
197197
on an LED on a specific Trellis
198198
board.
@@ -211,16 +211,16 @@ def led_on(self, x, *matrices):
211211
def led_off(self, x, *matrices):
212212
"""
213213
Turn off the specified LED in the display buffer. Must call
214-
`[trellis].show()` afterwards to update the matrix.
214+
``trellis.show()`` afterwards to update the matrix.
215215
216216
:param int x: Number of LED you wish to turn off. When not including
217-
specific `trellis.TRELLIS` objects (`*matrices` param),
218-
the range of `x` is 0 to the maximum number of LEDs you
219-
have (4 Trellis boards: 0-63). When using `*matrices`,
220-
the range of `x` is 0-15 for the LED on each Trellis.
217+
specific ``trellis.TRELLIS`` objects (``*matrices`` param),
218+
the range of ``x`` is 0 to the maximum number of LEDs you
219+
have (4 Trellis boards: 0-63). When using ``*matrices``,
220+
the range of ``x`` is 0-15 for the LED on each Trellis.
221221
222-
:param ~trellis.TRELLIS matrices: List of `trellis.TRELLIS` objects
223-
you wish to turn off the LED `x`.
222+
:param ~trellis.TRELLIS matrices: List of ``trellis.TRELLIS`` objects
223+
you wish to turn off the LED ``x``.
224224
Only required if you want to turn
225225
off an LED on a specific Trellis
226226
board.
@@ -241,13 +241,13 @@ def led_status(self, x, *matrices):
241241
Gives the current status of an LED: True == ON, False == OFF
242242
243243
:param int x: Number of LED you wish to check. When not including
244-
specific `trellis.TRELLIS` objects (`*matrices` param),
245-
the range of `x` is 0 to the maximum number of LEDs you
246-
have (4 Trellis boards: 0-63). When using `*matrices`,
247-
the range of `x` is 0-15 for the LED on each Trellis.
244+
specific ``trellis.TRELLIS`` objects (``*matrices`` param),
245+
the range of ``x`` is 0 to the maximum number of LEDs you
246+
have (4 Trellis boards: 0-63). When using ``*matrices``,
247+
the range of ``x`` is 0-15 for the LED on each Trellis.
248248
249-
:param ~trellis.TRELLIS matrices: List of `trellis.TRELLIS` objects
250-
you wish to check the LED `x`.
249+
:param ~trellis.TRELLIS matrices: List of ``trellis.TRELLIS`` objects
250+
you wish to check the LED ``x``.
251251
Only required if you want to check
252252
an LED on a specific Trellis board.
253253
"""
@@ -268,7 +268,7 @@ def fill(self, color, *matrices):
268268
269269
:param int color: 0 == OFF, > 0 == ON
270270
271-
:param ~trellis.TRELLIS matrices: List of `trellis.TRELLIS` objects
271+
:param ~trellis.TRELLIS matrices: List of ``trellis.TRELLIS`` objects
272272
you wish to fill with the given color.
273273
Only required if you want to fill
274274
the color on a specific Trellis board.
@@ -284,7 +284,7 @@ def read_buttons(self, *matrices):
284284
"""
285285
Read the button matrix register on the Trellis.
286286
287-
:param ~trellis.TRELLIS matrices: List of `trellis.TRELLIS` object(s)
287+
:param ~trellis.TRELLIS matrices: List of ``trellis.TRELLIS`` object(s)
288288
you wish to read the button matrix of.
289289
Only required if you want to read the
290290
the buttons on a specific Trellis board.
@@ -305,13 +305,13 @@ def just_pressed(self, button, *matrices):
305305
the button was/is depressed. Returns zero otherwise.
306306
307307
:param int button: Number of the button you wish to check.
308-
When not including specific `trellis.TRELLIS` objects
309-
(`*matrices` param), the range of `x` is 0 to the
308+
When not including specific ``trellis.TRELLIS`` objects
309+
(``*matrices`` param), the range of ``button`` is 0 to the
310310
maximum number of buttons available (4 boards: 0-63).
311-
When using `*matrices`, the range of `button` is 0-15
311+
When using ``*matrices``, the range of ``button`` is 0-15
312312
for the button on each Trellis.
313313
314-
:param ~trellis.TRELLIS matrices: List of `trellis.TRELLIS` object you
314+
:param ~trellis.TRELLIS matrices: List of ``trellis.TRELLIS`` object you
315315
wish to check the button on.
316316
Only required if you want to read the
317317
the buttons on a specific Trellis board.
@@ -336,13 +336,13 @@ def just_released(self, button, *matrices):
336336
the button was/is released. Returns zero otherwise.
337337
338338
:param int button: Number of the button you wish to check.
339-
When not including specific `trellis.TRELLIS` objects
340-
(`*matrices` param), the range of `x` is 0 to the
339+
When not including specific ``trellis.TRELLIS`` objects
340+
(``*matrices`` param), the range of ``button`` is 0 to the
341341
maximum number of buttons available (4 boards: 0-63).
342-
When using `*matrices`, the range of `button` is 0-15
342+
When using ``*matrices``, the range of ``button`` is 0-15
343343
for the button on each Trellis.
344344
345-
:param ~trellis.TRELLIS matrices: List of `trellis.TRELLIS` object you
345+
:param ~trellis.TRELLIS matrices: List of ``trellis.TRELLIS`` object you
346346
wish to check the button on.
347347
Only required if you want to read the
348348
the buttons on a specific Trellis board.

0 commit comments

Comments
 (0)