Skip to content

Fix documentation #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 28, 2022
Merged

Fix documentation #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions adafruit_ra8875/ra8875.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,15 @@ class RA8875_Device:
"""
Base Class for the Display. Contains all the low level stuff. As well
as the touch functions. Valid display sizes are currently 800x480 and 480x272.

:param SPI spi: The spi peripheral to use
:param DigitalInOut cs: The chip-select pin to use (sometimes labeled "SS")
:param DigitalInOut rst: (optional) The reset pin if it exists (default=None)
:param int width: (optional) The width of the display in pixels (default=800)
:param int height: (optional) The height of the display in pixels (default=480)
:param int baudrate: (optional) The spi speed (default=6000000)
:param int polarity: (optional) The spi polarity (default=0)
:param int phase: (optional) The spi phase (default=0)
"""

# pylint: disable-msg=invalid-name,too-many-arguments
Expand All @@ -68,16 +77,6 @@ def __init__(
polarity=0,
phase=0,
):
"""
:param SPI spi: The spi peripheral to use
:param DigitalInOut cs: The chip-select pin to use (sometimes labeled "SS")
:param DigitalInOut rst: (optional) The reset pin if it exists (default=None)
:param int width: (optional) The width of the display in pixels (default=800)
:param int height: (optional) The height of the display in pixels (default=480)
:param int baudrate: (optional) The spi speed (default=6000000)
:param int phase: (optional) The spi phase (default=0)
:param int polarity: (optional) The spi polarity (default=0)
"""
self.spi_device = spi_device.SPIDevice(
spi, cs, baudrate=baudrate, polarity=polarity, phase=phase
)
Expand Down