Skip to content

Add param types to docstrings, use tables #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.

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 24, 2022
Merged

Add param types to docstrings, use tables #25

merged 2 commits into from
Feb 24, 2022

Conversation

tekktrik
Copy link
Member

  1. Adds param types to the docstrings
  2. Converts the gain and error descriptions to use table markup (error wasn't rendering properly as a list as is)
  3. Should resolve RTD not showing documentation #24 by rebuilding the documentation

@tekktrik tekktrik requested a review from a team February 24, 2022 20:06
@tekktrik tekktrik merged commit 9da9424 into adafruit:main Feb 24, 2022
@tekktrik tekktrik deleted the docstring-touchup branch February 24, 2022 21:04
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Feb 25, 2022
@adafruit-adabot
Automated update by Adabot (adafruit/adabot@8ce3914)
dcee57a 
Updating https://github.com/adafruit/Adafruit_CircuitPython_Nunchuk to 1.1.1 from 1.1.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_Nunchuk#29 from tekktrik/doc/add-typing
  > Fixed readthedocs build

Updating https://github.com/adafruit/Adafruit_CircuitPython_VL6180X to 1.4.1 from 1.4.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_VL6180X#25 from tekktrik/docstring-touchup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ladyada ladyada ladyada 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.

RTD not showing documentation
2 participants
@tekktrik @ladyada