Skip to content

Commit 12fc2a1

Browse files
committed
Sphinx tweaks.
1 parent 902e6aa commit 12fc2a1

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

adafruit_tpa2016.py

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -98,17 +98,25 @@ class TPA2016:
9898
"""NoiseGate function enable. Enabled by default. Can only be enabled when compression ratio
9999
is NOT 1:1. To disable, set to ``False``."""
100100
output_limiter_disable = RWBit(0x06, 7)
101-
"""Output limiter disable. Enabled by default when compression ratio is NOT 1:1. Can only be
102-
disabled if compression ratio is 1:1. To disable, set to ``True``."""
101+
"""
102+
103+
Output limiter disable.
104+
105+
Enabled by default when compression ratio is NOT 1:1. Can only be
106+
disabled if compression ratio is 1:1. To disable, set to ``True``.
107+
"""
103108

104109
noise_gate_threshold = RWBits(2, 0x06, 5)
105-
"""Noise Gate threshold in mV. Noise gate settings are 1mV, 4mV, 10mV, and 20mV. Settings
110+
"""
111+
Noise Gate threshold in mV.
112+
113+
Noise gate settings are 1mV, 4mV, 10mV, and 20mV. Settings
106114
options are NOISE_GATE_1, NOISE_GATE_4, NOISE_GATE_10, NOISE_GATE_20. Only functional when
107115
compression ratio is NOT 1:1. Defaults to 4mV.
108116
109117
This example sets the noise gate threshold to 10mV.
110118
111-
..code-block:: python
119+
.. code-block:: python
112120
113121
import adafruit_tpa2016
114122
import busio
@@ -122,12 +130,15 @@ class TPA2016:
122130
"""
123131

124132
compression_ratio = RWBits(2, 0x07, 0)
125-
"""The compression ratio. Ratio settings are: 1:1. 2:1, 4:1, 8:1. Settings options are:
133+
"""
134+
The compression ratio.
135+
136+
Ratio settings are: 1:1. 2:1, 4:1, 8:1. Settings options are:
126137
COMPRESSION_1_1, COMPRESSION_2_1, COMPRESSION_4_1, COMPRESSION_8_1. Defaults to 4:1.
127138
128139
This example sets the compression ratio to 2:1.
129140
130-
..code-block:: python
141+
.. code-block:: python
131142
132143
import adafruit_tpa2016
133144
import busio
@@ -151,7 +162,7 @@ def attack_time(self):
151162
152163
This example sets the attack time to 1, or 0.1067ms.
153164
154-
..code-block:: python
165+
.. code-block:: python
155166
156167
import adafruit_tpa2016
157168
import busio
@@ -180,7 +191,7 @@ def release_time(self):
180191
181192
This example sets release time to 1, or 0.0137ms.
182193
183-
..code-block:: python
194+
.. code-block:: python
184195
185196
import adafruit_tpa2016
186197
import busio
@@ -209,7 +220,7 @@ def hold_time(self):
209220
210221
This example sets hold time to 1, or 0.0137ms.
211222
212-
..code-block:: python
223+
.. code-block:: python
213224
214225
import adafruit_tpa2016
215226
import busio
@@ -238,7 +249,7 @@ def fixed_gain(self):
238249
239250
The following example sets the fixed gain to -16dB.
240251
241-
..code-block:: python
252+
.. code-block:: python
242253
243254
import adafruit_tpa2016
244255
import busio

0 commit comments

Comments
 (0)