Skip to content
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

Add additional documentation for modules, builtin exceptions #6391

Merged
merged 13 commits into from May 13, 2022

Conversation

tekktrik
Copy link
Member

@tekktrik tekktrik commented May 13, 2022

Another day, another documentation PR! Resolves #6381, and works towards #6326:

  • Adds additional exceptions to builtins

Adds links to guides/libraries for:

  • qrio
  • fontio
  • terminalio (really just a note additional that it doesn't give REPL access with link to REPL guide page)
  • microcontroller (actually just a touchup, no linking)
  • audiomp3
  • rp2pio
  • alarm
  • bitmaptools

Also makes additions from #6353 prettier.

Documentation builds locally!

dhalbert
dhalbert previously approved these changes May 13, 2022
Copy link
Collaborator

@dhalbert dhalbert left a comment

Choose a reason for hiding this comment

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

These cross-references are excellent. Thank you!

I suggested some changes from "library" to "module", when describing a built-in module.

shared-bindings/fontio/__init__.c Outdated Show resolved Hide resolved
shared-bindings/neopixel_write/__init__.c Outdated Show resolved Hide resolved
shared-bindings/qrio/__init__.c Outdated Show resolved Hide resolved
@tekktrik
Copy link
Member Author

Ah, good call!

@dhalbert dhalbert merged commit 951eea7 into adafruit:main May 13, 2022
@dhalbert
Copy link
Collaborator

Cancelled full build run, since the doc build is fine, and we don't need to test every build.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing documentation for builtin exceptions
2 participants