Improve Ref Docs #3

sommersoft · 2018-03-02T01:06:37Z

The following Learn Guide will need the 2 GitHub example code links updated:
https://learn.adafruit.com/adafruit-lsm9ds0-accelerometer-gyro-magnetometer-9-dof-breakouts?view=all#circuitpython-code

kattni

Thanks for doing this! See inline change requests.

kattni · 2018-03-05T22:20:46Z

adafruit_lsm9ds0.py

@@ -248,7 +265,7 @@ def read_accel_raw(self):

    @property
    def accelerometer(self):
-        """Get the accelerometer X, Y, Z axis values as a 3-tuple of
+        """Returns the accelerometer X, Y, Z axis values as a 3-tuple of
        m/s^2 values.


"The accelerometer ..." Doesn't need "Returns".

kattni · 2018-03-05T22:20:52Z

adafruit_lsm9ds0.py

@@ -269,7 +286,7 @@ def read_mag_raw(self):

    @property
    def magnetometer(self):
-        """Get the magnetometer X, Y, Z axis values as a 3-tuple of
+        """Returns the magnetometer X, Y, Z axis values as a 3-tuple of
        gauss values.


kattni · 2018-03-05T22:21:00Z

adafruit_lsm9ds0.py

@@ -289,7 +306,7 @@ def read_gyro_raw(self):

    @property
    def gyroscope(self):
-        """Get the gyroscope X, Y, Z axis values as a 3-tuple of
+        """Returns the gyroscope X, Y, Z axis values as a 3-tuple of


kattni · 2018-03-05T22:21:05Z

adafruit_lsm9ds0.py

@@ -308,7 +325,7 @@ def read_temp_raw(self):

    @property
    def temperature(self):
-        """Get the temperature of the sensor in degrees Celsius."""
+        """Returns the temperature of the sensor in degrees Celsius."""


sommersoft · 2018-03-05T23:10:29Z

And here I was thinking "I'll surprise kattni and get these right"... 😄

kattni · 2018-03-06T00:14:34Z

You're doing a great job! There's obviously a learning curve when you run into new things. :) You've been picking everything up amazingly! Thank you again!

…

On Mon, Mar 5, 2018 at 6:10 PM, sommersoft ***@***.***> wrote: And here I was thinking "I'll surprise kattni and get these right"... 😄 — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#3 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AHgDAmPK8h0Me6Omu7-yHG_QQ0S7KqwCks5tbcXmgaJpZM4SZPrl> .

kattni

Excellent!

Updating https://github.com/adafruit/Adafruit_CircuitPython_GPS to 3.1.0 from 3.0.2: > Merge pull request adafruit/Adafruit_CircuitPython_GPS#7 from kattni/pypi > updated CoC > Merge pull request adafruit/Adafruit_CircuitPython_GPS#6 from margaret/issue_5 > Merge pull request adafruit/Adafruit_CircuitPython_GPS#4 from sommersoft/new_docs Updating https://github.com/adafruit/Adafruit_CircuitPython_HT16K33 to 2.1.0 from 2.0.2: > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#19 from kattni/pypi > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#18 from caternuson/iss17 > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#16 from caternuson/iss7 > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#15 from caternuson/iss13b > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#14 from caternuson/iss13 > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#12 from caternuson/iss3 > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#11 from caternuson/iss3 > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#10 from elmwoodelec/master > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#6 from sommersoft/new_docs Updating https://github.com/adafruit/Adafruit_CircuitPython_IRRemote to 3.3.0 from 3.2.0: > Merge pull request adafruit/Adafruit_CircuitPython_IRRemote#15 from kattni/pypi > Merge pull request adafruit/Adafruit_CircuitPython_IRRemote#14 from kattni/add-tx-example Updating https://github.com/adafruit/Adafruit_CircuitPython_IS31FL3731 to 2.2.0 from 2.1.2: > Merge pull request adafruit/Adafruit_CircuitPython_IS31FL3731#11 from kattni/pypi > updated CoC > Merge pull request adafruit/Adafruit_CircuitPython_IS31FL3731#10 from sommersoft/new_docs Updating https://github.com/adafruit/Adafruit_CircuitPython_L3GD20 to 1.1.0 from 1.0.1: > Merge pull request adafruit/Adafruit_CircuitPython_L3GD20#4 from kattni/pypi > updated CoC > Merge pull request adafruit/Adafruit_CircuitPython_L3GD20#3 from mrmcwethy/fixdocs Updating https://github.com/adafruit/Adafruit_CircuitPython_LSM303 to 1.2.0 from 1.1.0: > Merge pull request adafruit/Adafruit_CircuitPython_LSM303#5 from kattni/pypi > updated CoC > Merge pull request adafruit/Adafruit_CircuitPython_LSM303#4 from sommersoft/new_docs Updating https://github.com/adafruit/Adafruit_CircuitPython_LSM9DS0 to 1.1.0 from 1.0.1: > Merge pull request adafruit/Adafruit_CircuitPython_LSM9DS0#5 from kattni/pypi > updated CoC > Merge pull request adafruit/Adafruit_CircuitPython_LSM9DS0#3 from sommersoft/new_docs Updating https://github.com/adafruit/Adafruit_CircuitPython_LSM9DS1 to 1.1.0 from 1.0.1: > Merge pull request adafruit/Adafruit_CircuitPython_LSM9DS1#7 from kattni/pypi > updated CoC > Merge pull request adafruit/Adafruit_CircuitPython_LSM9DS1#5 from sommersoft/new_docs > Merge pull request adafruit/Adafruit_CircuitPython_LSM9DS1#3 from sommersoft/new_docs Updating https://github.com/adafruit/Adafruit_CircuitPython_MatrixKe to 1.1.1 from 1.0.0: > Merge pull request adafruit/Adafruit_CircuitPython_MatrixKe#2 from kattni/badge-fix > Merge pull request adafruit/Adafruit_CircuitPython_MatrixKe#1 from kattni/pypi > updated CoC Updating https://github.com/adafruit/Adafruit_CircuitPython_MAX31855 to 3.0.3 from 3.0.2: > Merge pull request adafruit/Adafruit_CircuitPython_MAX31855#7 from kattni/fixes Updating https://github.com/adafruit/Adafruit_CircuitPython_MAX31865 to 2.1.0 from 2.0.2: > Merge pull request adafruit/Adafruit_CircuitPython_MAX31865#6 from kattni/pypi > updated CoC Updating https://github.com/adafruit/Adafruit_CircuitPython_MAX7219 to 1.1.0 from 1.0.1: > Merge pull request adafruit/Adafruit_CircuitPython_MAX7219#13 from kattni/lint-fix > Merge pull request adafruit/Adafruit_CircuitPython_MAX7219#12 from kattni/pypi > updated CoC > Merge pull request adafruit/Adafruit_CircuitPython_MAX7219#11 from sommersoft/new_docs Updating https://github.com/adafruit/Adafruit_CircuitPython_MAX9744 to 1.1.0 from 1.0.2: > Merge pull request adafruit/Adafruit_CircuitPython_MAX9744#6 from kattni/pypi > updated CoC > Merge pull request adafruit/Adafruit_CircuitPython_MAX9744#5 from sommersoft/new_docs > Merge pull request adafruit/Adafruit_CircuitPython_MAX9744#4 from sommersoft/new_docs Updating https://github.com/adafruit/Adafruit_CircuitPython_MCP2 to 1.1.0 from 1.0.0: > Merge pull request adafruit/Adafruit_CircuitPython_MCP2#3 from kattni/pypi > updated CoC > attack of the typo > Get ready to PyPI > Merge pull request adafruit/Adafruit_CircuitPython_MCP2#2 from adafruit/deshipu-patch-1 Updating https://github.com/adafruit/Adafruit_CircuitPython_MCP4725 to 1.1.0 from 1.0.2: > Merge pull request adafruit/Adafruit_CircuitPython_MCP4725#5 from kattni/pypi > updated CoC Updating https://github.com/adafruit/Adafruit_CircuitPython_MCP9808 to 3.2.0 from 3.1.1: > Merge pull request adafruit/Adafruit_CircuitPython_MCP9808#14 from kattni/pypi > updated CoC Updating https://github.com/adafruit/Adafruit_CircuitPython_MMA8451 to 1.1.0 from 1.0.1: > Merge pull request adafruit/Adafruit_CircuitPython_MMA8451#2 from kattni/pypi > updated CoC > Merge pull request adafruit/Adafruit_CircuitPython_MMA8451#1 from jepler/import-struct Updating https://github.com/adafruit/Adafruit_CircuitPython_MPL3115A2 to 1.1.0 from 1.0.3: > Merge pull request adafruit/Adafruit_CircuitPython_MPL3115A2#3 from kattni/pypi > updated CoC Updating https://github.com/adafruit/Adafruit_CircuitPython_MPR121 to 1.1.0 from 1.0.2: > Merge pull request adafruit/Adafruit_CircuitPython_MPR121#7 from kattni/pypi > updated CoC

sommersoft added 9 commits March 1, 2018 17:49

renamed example; 1 learn guide requires update

f87a716

setup docs folder

aae1a22

updated .travis & .readthedocs yml

294b199

updated README

3e323dd

updated info docstring

a355f8a

sphinx fix

eed6cb9

sphin fix2

1d848ee

sphin fix2.1

96f28ea

remove 'get/set' docstring statements; finally remembered to look

e5f6b38

kattni suggested changes Mar 5, 2018

View reviewed changes

sommersoft added 3 commits March 6, 2018 20:37

updated docstrings; removed 'returns'

c07fd88

updated README; added Travis badge

f97265a

updated conf.py; bus device intersphinx link

c3fc3cd

kattni approved these changes Mar 11, 2018

View reviewed changes

kattni merged commit f88b765 into adafruit:master Mar 11, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve Ref Docs #3

Improve Ref Docs #3

sommersoft commented Mar 2, 2018

kattni left a comment

kattni Mar 5, 2018

kattni Mar 5, 2018

kattni Mar 5, 2018

kattni Mar 5, 2018

sommersoft commented Mar 5, 2018

kattni commented Mar 6, 2018 via email

kattni left a comment

Improve Ref Docs #3

Improve Ref Docs #3

Conversation

sommersoft commented Mar 2, 2018

kattni left a comment

Choose a reason for hiding this comment

kattni Mar 5, 2018

Choose a reason for hiding this comment

kattni Mar 5, 2018

Choose a reason for hiding this comment

kattni Mar 5, 2018

Choose a reason for hiding this comment

kattni Mar 5, 2018

Choose a reason for hiding this comment

sommersoft commented Mar 5, 2018

kattni commented Mar 6, 2018 via email

kattni left a comment

Choose a reason for hiding this comment