Skip to content

Use :rtype: to clarify types returned because of __get__() #28

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
Feb 18, 2022
Merged

Use :rtype: to clarify types returned because of __get__() #28

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
10 changes: 9 additions & 1 deletion adafruit_as7341.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,12 +325,20 @@ class AS7341: # pylint:disable=too-many-instance-attributes, no-member
_all_channels: Struct = Struct(_AS7341_ASTATUS, "<BHHHHHH")
_led_current_bits: RWBits = RWBits(7, _AS7341_LED, 0)
_led_enabled = RWBit(_AS7341_LED, 7)

atime: UnaryStruct = UnaryStruct(_AS7341_ATIME, "<B")
"""The integration time step count.
Total integration time will be ``(ATIME + 1) * (ASTEP + 1) * 2.78µS``

:rtype: int
"""

astep: UnaryStruct = UnaryStruct(_AS7341_ASTEP_L, "<H")
""" The integration time step size in 2.78 microsecond increments"""
"""The integration time step size in 2.78 microsecond increments

:rtype: int
"""

_gain: UnaryStruct = UnaryStruct(_AS7341_CFG1, "<B")
_data_ready_bit: RWBit = RWBit(_AS7341_STATUS2, 6)
"""
Expand Down