Improve Ref Docs #3

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

Jump to bottom

Merged

kattni merged 7 commits into adafruit:master from sommersoft:new_docs

Mar 9, 2018

Collaborator

sommersoft commented Mar 4, 2018

The following Learn Guide will need the 2 GitHub example code links updated:
https://learn.adafruit.com/adafruit-color-sensors?view=all#circuitpython-code

sommersoft added 6 commits

March 3, 2018 19:10


          renamed example; 1 learn guide will need links updated

a7a2bec


          setup docs folder

5eb30e9


          updated .travis & .readthedocs yml

5c0210b


          updated README

ab70b9e


          updated info docstring; removed 'get/set' from docstrings

1b26033


          sphinx fix

c5b7603

kattni suggested changes

View reviewed changes

Contributor

kattni left a comment

Thanks for doing this! One inline change requested.

adafruit_tcs34725.py Outdated

@@ @@ -174,7 +191,7 @@ def gain(self, val): @@
                   @property
                   def interrupt(self):
-                      """Get and clear the interrupt of the sensor.  Returns a bool that's
+                      """Return and clear the interrupt of the sensor.  Returns a bool that's

Contributor

kattni Mar 5, 2018

Delete this line entirely. When finished, should read True if the interrupt is set. Can be set to False (and only False) to clear the interrupt.


          updated docstring

kattni approved these changes

View reviewed changes

Contributor

kattni commented Mar 9, 2018

Thanks for fixing this up!

kattni merged commit 2b763c3 into adafruit:master

Contributor

kattni commented Mar 9, 2018

Guide updated

tannewt pushed a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request


          Automated update by Adabot (adafruit/adabot@e893f58)

a048da7

Updating https://github.com/adafruit/Adafruit_CircuitPython_PCF8523 to 1.2.0 from 1.1.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_PCF8523#7 from kattni/pypi
  > updated CoC

Updating https://github.com/adafruit/Adafruit_CircuitPython_Pixie to 1.1.0 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_Pixie#5 from kattni/pypi
  > Merge pull request adafruit/Adafruit_CircuitPython_Pixie#4 from kattni/documentation-setup
  > Merge pull request adafruit/Adafruit_CircuitPython_Pixie#3 from kattni/documentation-setup

Updating https://github.com/adafruit/Adafruit_CircuitPython_RFM69 to 1.2.0 from 1.1.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_RFM69#9 from kattni/pypi

Updating https://github.com/adafruit/Adafruit_CircuitPython_RFM9x to 1.1.0 from 1.0.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_RFM9x#7 from kattni/pypi
  > updated CoC

Updating https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display to 3.1.0 from 3.0.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_RGB_Display#22 from kattni/pypi
  > updated CoC
  > Merge pull request adafruit/Adafruit_CircuitPython_RGB_Display#18 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_RGB_Display#17 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_SD to 3.2.1 from 3.1.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_SD#10 from kattni/pypi
  > updated CoC

Updating https://github.com/adafruit/Adafruit_CircuitPython_SGP30 to 1.1.0 from 1.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_SGP30#8 from kattni/pypi
  > updated CoC
  > Merge pull request adafruit/Adafruit_CircuitPython_SGP30#7 from adafruit/tannewt-patch-1
  > Merge pull request adafruit/Adafruit_CircuitPython_SGP30#6 from brentru/sensor-prop
  > Merge pull request adafruit/Adafruit_CircuitPython_SGP30#5 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_SGP30#4 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_SH to 2.0.0 from 1.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_SH#7 from kattni/driver-rename
  > Merge pull request adafruit/Adafruit_CircuitPython_SH#6 from kattni/pypi
  > updated CoC

Updating https://github.com/adafruit/Adafruit_CircuitPython_SI4713 to 1.1.0 from 1.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_SI4713#4 from kattni/pypi
  > updated CoC
  > Merge pull request adafruit/Adafruit_CircuitPython_SI4713#3 from jepler/import-struct

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

Updating https://github.com/adafruit/Adafruit_CircuitPython_SI7021 to 3.1.0 from 3.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_SI7021#9 from kattni/pypi
  > updated CoC
  > Merge pull request adafruit/Adafruit_CircuitPython_SI7021#8 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_SI7021#7 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_SSD1306 to 2.4.0 from 2.3.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_SSD1306#11 from kattni/pypi
  > updated CoC

Updating https://github.com/adafruit/Adafruit_CircuitPython_STMPE610 to 1.1.0 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_STMPE610#6 from kattni/pypi

Updating https://github.com/adafruit/Adafruit_CircuitPython_TCS34725 to 3.1.0 from 3.0.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_TCS34725#6 from kattni/pypi
  > updated CoC
  > Merge pull request adafruit/Adafruit_CircuitPython_TCS34725#5 from dherrada/master
  > Merge pull request adafruit/Adafruit_CircuitPython_TCS34725#3 from sommersoft/new_docs

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

Updating https://github.com/adafruit/Adafruit_CircuitPython_BusDevice to 2.2.3 from 2.2.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_BusDevice#18 from kattni/minor-fixes
  > updated CoC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet