Skip to content
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

Improve Ref Docs #3

Merged
merged 8 commits into from
Mar 9, 2018
Merged

Improve Ref Docs #3

merged 8 commits into from
Mar 9, 2018

Conversation

sommersoft
Copy link
Collaborator

Per Issue #566

The following Learn Guide will need the 1 GitHub example code link updated:
https://learn.adafruit.com/using-vcnl4010-proximity-sensor?view=all#circuitpython-code

Copy link
Contributor

@kattni kattni left a comment

Choose a reason for hiding this comment

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

Thanks for doing this! Please resolve inline change requests.

@@ -168,7 +184,7 @@ def frequency(self, val):
# pylint: disable=inconsistent-return-statements
@property
def proximity(self):
"""Get the detected proximity of an object in front of the sensor. This
"""Returns the detected proximity of an object in front of the sensor. This
Copy link
Contributor

Choose a reason for hiding this comment

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

"The detected ..." Remove "Returns".

@@ -189,7 +205,7 @@ def proximity(self):

@property
def ambient(self):
"""Get the detected ambient light in front of the sensor. This is
"""Returns the detected ambient light in front of the sensor. This is
Copy link
Contributor

Choose a reason for hiding this comment

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

Same.

@@ -208,7 +224,7 @@ def ambient(self):

@property
def ambient_lux(self):
"""Get the detected ambient light in front of the sensor as a value in
"""Returns the detected ambient light in front of the sensor as a value in
Copy link
Contributor

Choose a reason for hiding this comment

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

Same.

@kattni
Copy link
Contributor

kattni commented Mar 9, 2018

Looks great, thanks!

@kattni kattni merged commit 4b595ea into adafruit:master Mar 9, 2018
@kattni
Copy link
Contributor

kattni commented Mar 9, 2018

Guide updated.

tannewt pushed a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Aug 9, 2018
Updating https://github.com/adafruit/Adafruit_CircuitPython_TLC5947 to 1.1.0 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_TLC5947#3 from kattni/pypi
  > updated CoC

Updating https://github.com/adafruit/Adafruit_CircuitPython_TLC59711 to 1.1.0 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_TLC59711#3 from kattni/pypi
  > updated CoC
  > Merge pull request adafruit/Adafruit_CircuitPython_TLC59711#2 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_Trellis to 1.1.0 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_Trellis#8 from kattni/pypi
  > updated CoC
  > Merge pull request adafruit/Adafruit_CircuitPython_Trellis#7 from sommersoft/val_checks
  > Merge pull request adafruit/Adafruit_CircuitPython_Trellis#5 from sommersoft/bytearray_fix

Updating https://github.com/adafruit/Adafruit_CircuitPython_TSL2561 to 3.1.1 from 3.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_TSL2561#16 from kattni/pypi
  > updated CoC
  > Merge pull request adafruit/Adafruit_CircuitPython_TSL2561#15 from caternuson/master
  > Merge pull request adafruit/Adafruit_CircuitPython_TSL2561#14 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_TSL2561#13 from caternuson/master

Updating https://github.com/adafruit/Adafruit_CircuitPython_TSL2591 to 1.1.0 from 1.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_TSL2591#4 from kattni/pypi
  > updated CoC

Updating https://github.com/adafruit/Adafruit_CircuitPython_VC0706 to 3.1.0 from 3.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_VC0706#4 from kattni/pypi
  > updated CoC

Updating https://github.com/adafruit/Adafruit_CircuitPython_VCNL4010 to 0.9.0 from 0.8.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_VCNL4010#4 from kattni/pypi
  > updated CoC
  > Merge pull request adafruit/Adafruit_CircuitPython_VCNL4010#3 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_VEML6070 to 1.1.0 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_VEML6070#4 from kattni/pypi
  > updated CoC
  > Merge pull request adafruit/Adafruit_CircuitPython_VEML6070#3 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_VL53L0X to 3.1.0 from 3.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_VL53L0X#4 from kattni/pypi
  > updated CoC
  > Merge pull request adafruit/Adafruit_CircuitPython_VL53L0X#3 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_VL6180X to 1.1.0 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_VL6180X#4 from kattni/pypi
  > updated CoC
  > Merge pull request adafruit/Adafruit_CircuitPython_VL6180X#3 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_WS2801 to 0.9.0 from 0.8.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_WS2801#2 from kattni/pypi
  > updated CoC
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