Skip to content

Fix autodoc + Usage Notes #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
merged 2 commits into from
Feb 22, 2018
Merged

Fix autodoc + Usage Notes #3

merged 2 commits into from
Feb 22, 2018

Conversation

brentru
Copy link
Member

@brentru brentru commented Feb 21, 2018

Added library usage notes into the README.
adafruit/circuitpython#624

kattni
kattni suggested changes Feb 21, 2018
View reviewed changes
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! The code is not rendering in README. Please resolve this.

README.rst Outdated

First, import the library:

.. code:: python
Copy link
Contributor

Choose a reason for hiding this comment

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

This isn't rendering when I view it. If it's working for you, let me know. Otherwise please sort what the issue is - it may need to be code-block.

Copy link
Member Author

@brentru brentru Feb 22, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the review. Code -> code-block and an extra space rendered correctly.

README.rst Outdated

Next, initialize the I2C bus object:

.. code:: python
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above.

README.rst Outdated

Since we have the I2C bus object, we can now use it to instantiate the SGP30 object:

.. code:: python
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above.

README.rst Outdated

To read from the sensor:

.. code:: python
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above.

@brentru
Updated README.rst
533ccd8 
code->code-block
@kattni
Copy link
Contributor

kattni commented Feb 22, 2018

Thanks for fixing this up!

@kattni kattni merged commit 0d9b68d into adafruit:master Feb 22, 2018
tannewt pushed a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Feb 22, 2018
@adafruit-adabot
Automated update by Adabot (adafruit/adabot@812c633)
6645b9f 
Updating https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15 to 0.2.1 from 0.2.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_ADS1x15#8 from brentru/fix-autodoc
  > Merge pull request adafruit/Adafruit_CircuitPython_ADS1x15#7 from caternuson/master
  > Merge pull request adafruit/Adafruit_CircuitPython_ADS1x15#5 from adafruit/tannewt-patch-1

Updating https://github.com/adafruit/Adafruit_CircuitPython_AMG to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_AMG#5 from brentru/improved-ref-docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_BNO055 to 3.0.1 from 3.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_BNO055#6 from brentru/autodoc-fix
  > Merge pull request adafruit/Adafruit_CircuitPython_BNO055#5 from mrmcwethy/examples

Updating https://github.com/adafruit/Adafruit_CircuitPython_DRV2605 to 0.8.1 from 0.8.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_DRV2605#3 from brentru/autodoc-fix
  > Merge pull request adafruit/Adafruit_CircuitPython_DRV2605#2 from brentru/readthedocs-badge
  > linting update

Updating https://github.com/adafruit/Adafruit_CircuitPython_OneWire to 1.0.1 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_OneWire#5 from brentru/autodoc-fix
  > Merge pull request adafruit/Adafruit_CircuitPython_OneWire#4 from brentru/readthedocs-badge
  > Merge pull request adafruit/Adafruit_CircuitPython_OneWire#3 from caternuson/master

Updating https://github.com/adafruit/Adafruit_CircuitPython_Fingerp to 1.0.1 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_Fingerp#5 from brentru/autodoc-fix
  > Merge pull request adafruit/Adafruit_CircuitPython_Fingerp#4 from brentru/readthedocs-badge

Updating https://github.com/adafruit/Adafruit_CircuitPython_FXAS21002C to 1.0.1 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_FXAS21002C#3 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_FXOS8700 to 1.0.1 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_FXOS8700#5 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_HT16K33 to 2.0.1 from 2.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#4 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_IS31FL3731 to 2.1.1 from 2.1.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_IS31FL3731#8 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_LIS3DH to 4.0.1 from 4.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_LIS3DH#24 from brentru/fix-autodoc
  > adding a gravitational constant and made the conversions a bit clearer
  > Merge pull request adafruit/Adafruit_CircuitPython_LIS3DH#20 from adafruit/jerryneedell-patch-1

Updating https://github.com/adafruit/Adafruit_CircuitPython_LSM9DS0 to 1.0.1 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_LSM9DS0#2 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_LSM9DS1 to 1.0.1 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_LSM9DS1#2 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_MAX9744 to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_MAX9744#3 from brentru/autodoc-fix

Updating https://github.com/adafruit/Adafruit_CircuitPython_Se to 1.0.1 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_Se#3 from brentru/patch-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_SGP30 to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_SGP30#3 from brentru/autodoc-fix
  > Merge pull request adafruit/Adafruit_CircuitPython_SGP30#2 from brentru/readthedocs-badge

Updating https://github.com/adafruit/Adafruit_CircuitPython_SH to 1.0.1 from 1.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_SH#3 from brentru/autodoc-fix
  > Merge pull request adafruit/Adafruit_CircuitPython_SH#2 from brentru/readthedocs-badge

Updating https://github.com/adafruit/Adafruit_CircuitPython_Thermal_Printer to 1.0.1 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_Thermal_Printer#2 from brentru/autodoc-fix
  > Merge pull request adafruit/Adafruit_CircuitPython_Thermal_Printer#1 from brentru/readthedocs-badge

Updating https://github.com/adafruit/Adafruit_CircuitPython_Thermistor to 3.1.1 from 3.1.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_Thermistor#3 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_VC0706 to 3.0.1 from 3.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_VC0706#2 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_VCNL4010 to 0.8.1 from 0.8.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_VCNL4010#2 from brentru/readthedocs-fix
  > Merge pull request adafruit/Adafruit_CircuitPython_VCNL4010#1 from brentru/readthedocs-badge

Updating https://github.com/adafruit/Adafruit_CircuitPython_VL6180X to 1.0.1 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_VL6180X#2 from brentru/autodoc-fix
  > Merge pull request adafruit/Adafruit_CircuitPython_VL6180X#1 from brentru/readthedocs-badge

Updating https://github.com/adafruit/Adafruit_CircuitPython_AVRprog to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_AVRprog#2 from brentru/autodoc-fix
  > Merge pull request adafruit/Adafruit_CircuitPython_AVRprog#1 from brentru/readthedocs-badge

Updating https://github.com/adafruit/Adafruit_CircuitPython_OneWire to 1.0.1 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_OneWire#5 from brentru/autodoc-fix
  > Merge pull request adafruit/Adafruit_CircuitPython_OneWire#4 from brentru/readthedocs-badge
  > Merge pull request adafruit/Adafruit_CircuitPython_OneWire#3 from caternuson/master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kattni kattni kattni approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@brentru @kattni