Skip to content

Include examples in the API documentation #25

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 3 commits into from
Mar 24, 2021
Merged

Include examples in the API documentation #25

merged 3 commits into from
Mar 24, 2021

Conversation

jposada202020
Copy link
Contributor

To include some examples in the API documentation. They are missing in readthedocs

@jposada202020 jposada202020 added the documentation Improvements or additions to documentation label Mar 22, 2021
@kmatch98
Copy link
Contributor

This is cool, I learned something today. I built the docs on my local machine and they look good to me. Thanks for this update!

@jposada202020
Copy link
Contributor Author

@kmatch98 thanks for the review.

@jposada202020 jposada202020 merged commit f33dfa9 into adafruit:main Mar 24, 2021
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Mar 24, 2021
Updating https://github.com/adafruit/Adafruit_CircuitPython_BNO08X to 1.1.0 from 1.0.6:
  > Merge pull request adafruit/Adafruit_CircuitPython_BNO08x#19 from adafruit/patch-test
  > Merge pull request adafruit/Adafruit_CircuitPython_BNO08x#14 from yugyesh/patch-3

Updating https://github.com/adafruit/Adafruit_CircuitPython_CAP1188 to 1.2.7 from 1.2.6:
  > Merge pull request adafruit/Adafruit_CircuitPython_CAP1188#20 from adafruit/linting
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_EMC2101 to 1.1.5 from 1.1.4:
  > Merge pull request adafruit/Adafruit_CircuitPython_EMC2101#7 from rpavlik/slim-lut
  > Merge pull request adafruit/Adafruit_CircuitPython_EMC2101#6 from rpavlik/split
  > Merge pull request adafruit/Adafruit_CircuitPython_EMC2101#9 from rpavlik/fix-lut
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI to 3.5.8 from 3.5.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_ESP32SPI#130 from adafruit/anecdata-patch-2
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_TLC5947 to 1.3.4 from 1.3.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_TLC5947#24 from adafruit/REUSE
  > "Increase duplicate code check threshold "
  > Re-added pylint install to build.yml
  > Removed pylint process from github workflow
  > Hardcoded Black and REUSE versions
  > Added pre-commit-config file
  > Added pre-commit and SPDX copyright

Updating https://github.com/adafruit/Adafruit_CircuitPython_TLV493D to 1.2.4 from 1.2.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_TLV493D#11 from lubarb/setup-edit
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_BLE_Cycling_Speed_and_Cadence to 1.1.4 from 1.1.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_BLE_Cycling_Speed_and_Cadence#6 from adafruit/pre-commit
  > "Increase duplicate code check threshold "
  > Re-added pylint install to build.yml
  > Removed pylint process from github workflow
  > Hardcoded Black and REUSE versions
  > Added pre-commit-config file
  > Added pre-commit and SPDX copyright

Updating https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout to 1.6.0 from 1.5.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_DisplayIO_Layout#18 from kmatch98/icon_palette
  > Merge pull request adafruit/Adafruit_CircuitPython_DisplayIO_Layout#25 from jposada202020/main
  > Merge pull request adafruit/Adafruit_CircuitPython_DisplayIO_Layout#24 from kmatch98/touch_fix

Updating https://github.com/adafruit/Adafruit_CircuitPython_HID to 4.2.0 from 4.1.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_HID#62 from jfurcean/add-led-status
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad to 0.14.1 from 0.14.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_ImageLoad#48 from FoamyGuy/readinto_fallback
  > Merge pull request adafruit/Adafruit_CircuitPython_ImageLoad#49 from kmatch98/readinto_fix

Updating https://github.com/adafruit/Adafruit_CircuitPython_MIDI to 1.3.4 from 1.3.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_MIDI#34 from adafruit/test-lint
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_PIOASM to 0.3.0 from 0.2.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_PIOASM#19 from adafruit/add-tests
  > Merge pull request adafruit/Adafruit_CircuitPython_PIOASM#18 from adafruit/jepler-rxuart-example
  > "Increase duplicate code check threshold "
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants