Skip to content

Commit ed8aec4

Browse files
committed
fixing short names
1 parent aa0e207 commit ed8aec4

File tree

4 files changed

+13
-17
lines changed

4 files changed

+13
-17
lines changed

.pylintrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
279279

280280
# Good variable names which should always be accepted, separated by a comma
281281
# good-names=i,j,k,ex,Run,_
282-
good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_
282+
good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_,cs
283283

284284
# Include a hint for the correct naming format with invalid-name
285285
include-naming-hint=no

adafruit_bme280/advanced.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ class Adafruit_BME280_SPI(Adafruit_BME280_Advanced):
325325
"""Driver for BME280 connected over SPI
326326
327327
:param ~busio.SPI spi: SPI device
328-
:param ~digitalio.DigitalInOut chip_select: Chip Select
328+
:param ~digitalio.DigitalInOut cs: Chip Select
329329
:param int baudrate: Clock rate, default is 100000. Can be changed with :meth:`baudrate`
330330
331331
.. note::
@@ -347,9 +347,9 @@ class Adafruit_BME280_SPI(Adafruit_BME280_Advanced):
347347
348348
.. code-block:: python
349349
350-
chip_select = digitalio.DigitalInOut(board.D10)
350+
cs = digitalio.DigitalInOut(board.D10)
351351
spi = board.SPI()
352-
bme280 = adafruit_bme280.Adafruit_BME280_SPI(spi, chip_select)
352+
bme280 = adafruit_bme280.Adafruit_BME280_SPI(spi, cs)
353353
354354
You need to setup the pressure at sea level
355355
@@ -369,7 +369,5 @@ class Adafruit_BME280_SPI(Adafruit_BME280_Advanced):
369369
370370
"""
371371

372-
def __init__(
373-
self, spi: SPI, chip_select: DigitalInOut, baudrate: int = 100000
374-
) -> None:
375-
super().__init__(SPI_Impl(spi, chip_select, baudrate))
372+
def __init__(self, spi: SPI, cs: DigitalInOut, baudrate: int = 100000) -> None:
373+
super().__init__(SPI_Impl(spi, cs, baudrate))

adafruit_bme280/basic.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ class Adafruit_BME280_SPI(Adafruit_BME280):
373373
"""Driver for BME280 connected over SPI
374374
375375
:param ~busio.SPI spi: SPI device
376-
:param ~digitalio.DigitalInOut chip_select: Chip Select
376+
:param ~digitalio.DigitalInOut cs: Chip Select
377377
:param int baudrate: Clock rate, default is 100000. Can be changed with :meth:`baudrate`
378378
379379
.. note::
@@ -395,9 +395,9 @@ class Adafruit_BME280_SPI(Adafruit_BME280):
395395
396396
.. code-block:: python
397397
398-
chip_select = digitalio.DigitalInOut(board.D10)
398+
cs = digitalio.DigitalInOut(board.D10)
399399
spi = board.SPI()
400-
bme280 = adafruit_bme280.Adafruit_BME280_SPI(spi, chip_select)
400+
bme280 = adafruit_bme280.Adafruit_BME280_SPI(spi, cs)
401401
402402
You need to setup the pressure at sea level
403403
@@ -417,7 +417,5 @@ class Adafruit_BME280_SPI(Adafruit_BME280):
417417
418418
"""
419419

420-
def __init__(
421-
self, spi: SPI, chip_select: DigitalInOut, baudrate: int = 100000
422-
) -> None:
423-
super().__init__(SPI_Impl(spi, chip_select, baudrate))
420+
def __init__(self, spi: SPI, cs: DigitalInOut, baudrate: int = 100000) -> None:
421+
super().__init__(SPI_Impl(spi, cs, baudrate))

adafruit_bme280/protocol.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ class SPI_Impl:
3737
def __init__(
3838
self,
3939
spi: SPI,
40-
chip_select: DigitalInOut,
40+
cs: DigitalInOut,
4141
baudrate: int = 100000,
4242
) -> None:
4343
from adafruit_bus_device import ( # pylint: disable=import-outside-toplevel
4444
spi_device,
4545
)
4646

47-
self._spi = spi_device.SPIDevice(spi, chip_select, baudrate=baudrate)
47+
self._spi = spi_device.SPIDevice(spi, cs, baudrate=baudrate)
4848

4949
def read_register(self, register: int, length: int) -> bytearray:
5050
"Read from the device register."

0 commit comments

Comments
 (0)