Skip to content

Remove unused interrupt pin arg and doc updates #34

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.

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 6 commits into from
Nov 5, 2021
Merged

Remove unused interrupt pin arg and doc updates #34

merged 6 commits into from
Nov 5, 2021

Conversation

fivesixzero
Copy link

Addresses #33 with some minor doc updates for good measure.

These changes don't have any effect on the example code or the function of the library. The only thing that the incoming interrupt_pin arg used to do was to set an internal variable that was never actually used.

An alternative approach would be to update the doc to indicate that we want a DigtalInOut rather than a Pin. Given that it isn't used, I've started with this PR. Feel free to reject the PR if this approach isn't appropriate. :)

@fivesixzero
Copy link
Author

Should be ready for review now that I've tidied up the typos and linter errors. :)

@fivesixzero
Copy link
Author

For good measure I double-checked the APDS9960 Learn Guide CircuitPython page.

The interrupt features aren't mentioned in there and the examples don't make use of the interrupt_pin argument. So this change won't cause problems there.

@tannewt tannewt requested a review from a team November 4, 2021 20:30
Copy link

@askpatrickw askpatrickw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did not test, but these changes look to be sound based on the conversation and the notes in the original Issue.

@askpatrickw askpatrickw merged commit 756f9d8 into adafruit:main Nov 5, 2021
@fivesixzero fivesixzero deleted the remove-unused-interrupt-pin-arg branch November 6, 2021 00:05
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Nov 14, 2021
Updating https://github.com/adafruit/Adafruit_CircuitPython_APDS9960 to 2.2.8 from 2.2.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_APDS9960#36 from fivesixzero/type-annotations
  > Updated readthedocs file
  > Merge pull request adafruit/Adafruit_CircuitPython_APDS9960#34 from fivesixzero/remove-unused-interrupt-pin-arg
  > Disabled unspecified-encoding pylint check
  > Merge pull request adafruit/Adafruit_CircuitPython_APDS9960#35 from adafruit/patch-test
  > add docs link to readme
  > Globally disabled consider-using-f-string pylint check
  > Moved default branch to main
  > Moved CI to Python 3.7
  > Added help text and problem matcher
  > Added pull request template

Updating https://github.com/adafruit/Adafruit_CircuitPython_AirLift to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_AirLift#6 from tekktrik/feature/add-typing
  > Updated readthedocs file
  > Disabled unspecified-encoding pylint check
  > PATCH Pylint and readthedocs patch test
  > add docs link to readme
  > Globally disabled consider-using-f-string pylint check
  > Moved CI to Python 3.7
  > Added help text and problem matcher
  > Added pull request template
  > "Increase duplicate code check threshold "
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants