Fix documentation of params and code blocks #86

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

tekktrik merged 1 commit into adafruit:main from Neradoc:fix-documentation-params-and-code-blocks

Mar 28, 2022

Contributor

Neradoc commented Mar 28, 2022

Missing new lines for parameters and spaces in .. code-block.
Fixes the display of the documentation, at least locally.


          Fix documentation of params and code blocks

a31b699

tekktrik approved these changes

View reviewed changes

Member

tekktrik left a comment

Looks great, nice!

tekktrik merged commit 5351105 into adafruit:main

adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request


          Automated update by Adabot (adafruit/adabot@d21f7d6)

76b68cd

Updating https://github.com/adafruit/Adafruit_CircuitPython_BluefruitSPI to 1.1.9 from 1.1.8:
  > Merge pull request adafruit/Adafruit_CircuitPython_BluefruitSPI#23 from Neradoc/fix-documentation-params
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground to 5.0.4 from 5.0.3:
  > Renamed advanced_examples/ to circuitplayground_advanced_examples
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_CLUE to 3.0.4 from 3.0.3:
  > Renamed advanced_examples/ to clue_advanced_examples/
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_FONA to 2.1.6 from 2.1.5:
  > Merge pull request adafruit/Adafruit_CircuitPython_FONA#16 from tekktrik/doc/add-typing
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_IS31FL3731 to 3.2.3 from 3.2.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_IS31FL3731#48 from adafruit/pb-cm
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_OV5640 to 1.1.0 from 1.0.5:
  > Merge pull request adafruit/Adafruit_CircuitPython_OV5640#14 from adafruit/seesawify
  > Fixed readthedocs build

Updating https://github.com/adafruit/Adafruit_CircuitPython_RPLIDAR to 1.2.5 from 1.2.4:
  > Merge pull request adafruit/Adafruit_CircuitPython_RPLIDAR#24 from adafruit/adabotify

Updating https://github.com/adafruit/Adafruit_CircuitPython_SD to 3.3.8 from 3.3.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_SD#46 from Neradoc/fix-documentation-params
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_STMPE610 to 1.3.2 from 1.3.1:
  > Rename stmpe610_touch_calibrator_.py to stmpe610_touch_calibrator.py
  > Update and rename touch_calibrator_stmpe610.py to stmpe610_touch_calibrator_.py
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_TFmini to 1.2.8 from 1.2.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_TFmini#11 from Neradoc/fix-documentation
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_GC_IOT_Core to 3.1.2 from 3.1.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_GC_IOT_Core#22 from Neradoc/fix-documentation-params-and-code-blocks

Updating https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO to 5.6.4 from 5.6.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_AdafruitIO#86 from Neradoc/fix-documentation-params-and-code-blocks
  > Merge pull request adafruit/Adafruit_CircuitPython_AdafruitIO#85 from tekktrik/dev/fix-missing-minimqtt-req

Updating https://github.com/adafruit/Adafruit_CircuitPython_AzureIoT to 2.5.2 from 2.5.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_AzureIoT#41 from adafruit/adabotify
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_binascii to 1.2.9 from 1.2.8:
  > Merge pull request adafruit/Adafruit_CircuitPython_binascii#14 from tekktrik/dev/fix-typing-to-bytes
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_BLE to 8.2.3 from 8.2.2:
  > Changed capitalization to satisfy adabot

Updating https://github.com/adafruit/Adafruit_CircuitPython_Dash_Dis to 1.1.3 from 1.1.2:
  > Renamed client_examples subdir
  > Fixed readthedocs build
  > Post-patch cleanup
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_MotorKit to 1.6.5 from 1.6.4:
  > Merge pull request adafruit/Adafruit_CircuitPython_MotorKit#43 from tekktrik/doc/add-typing
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_PIOASM to 0.6.2 from 0.6.1:
  > Rename rotaryencoder.py to pioasm_rotaryencoder.py
  > Merge pull request adafruit/Adafruit_CircuitPython_PIOASM#39 from adafruit/adabotify
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_PortalBase to 1.11.4 from 1.11.3:
  > Renamed adafruit_portalbase_simpletest.py to portalbase_simpletest.py
  > Moved example directory to examples

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

Labels

None yet