Skip to content

Commit 5f58029

Browse files
committed
Update Sphinx param formatting
1 parent 430b8aa commit 5f58029

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

adafruit_fram.py

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,11 @@
6262
class FRAM:
6363
"""
6464
Driver base for the FRAM Breakout.
65+
66+
:param int max_size: The maximum size of the EEPROM
67+
:param bool write_protect: Turns on/off initial write protection
68+
:param DigitalInOut wp_pin: (Optional) Physical pin connected to the ``WP`` breakout pin.
69+
Must be a ``DigitalInOut`` object.
6570
"""
6671

6772
def __init__(self, max_size: int, write_protect: bool = False, wp_pin: Optional[DigitalInOut] = None) -> None:
@@ -222,11 +227,11 @@ def _write(self, start_address: int, data: Union[int, Sequence[int]], wraparound
222227
class FRAM_I2C(FRAM):
223228
"""I2C class for FRAM.
224229
225-
:param: ~busio.I2C i2c_bus: The I2C bus the FRAM is connected to.
226-
:param: int address: I2C address of FRAM. Default address is ``0x50``.
227-
:param: bool write_protect: Turns on/off initial write protection.
230+
:param ~busio.I2C i2c_bus: The I2C bus the FRAM is connected to.
231+
:param int address: I2C address of FRAM. Default address is ``0x50``.
232+
:param bool write_protect: Turns on/off initial write protection.
228233
Default is ``False``.
229-
:param: wp_pin: (Optional) Physical pin connected to the ``WP`` breakout pin.
234+
:param wp_pin: (Optional) Physical pin connected to the ``WP`` breakout pin.
230235
Must be a ``digitalio.DigitalInOut`` object.
231236
"""
232237

@@ -301,12 +306,12 @@ def write_protected(self, value: bool) -> None:
301306
class FRAM_SPI(FRAM):
302307
"""SPI class for FRAM.
303308
304-
:param: ~busio.SPI spi_bus: The SPI bus the FRAM is connected to.
305-
:param: ~digitalio.DigitalInOut spi_cs: The SPI CS pin.
306-
:param: bool write_protect: Turns on/off initial write protection.
307-
Default is ``False``.
308-
:param: wp_pin: (Optional) Physical pin connected to the ``WP`` breakout pin.
309-
Must be a ``digitalio.DigitalInOut`` object.
309+
:param ~busio.SPI spi_bus: The SPI bus the FRAM is connected to.
310+
:param ~digitalio.DigitalInOut spi_cs: The SPI CS pin.
311+
:param bool write_protect: Turns on/off initial write protection.
312+
Default is ``False``.
313+
:param wp_pin: (Optional) Physical pin connected to the ``WP`` breakout pin.
314+
Must be a ``digitalio.DigitalInOut`` object.
310315
:param int baudrate: SPI baudrate to use. Default is ``1000000``.
311316
:param int max_size: Size of FRAM in Bytes. Default is ``8192``.
312317
"""

0 commit comments

Comments
 (0)