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.

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

Fix Issue 40: Docs rendering improperly for keys function #43

Merged
merged 3 commits into from
Sep 15, 2022
Merged

Fix Issue 40: Docs rendering improperly for keys function #43

merged 3 commits into from
Sep 15, 2022

Conversation

prcutler
Copy link
Contributor

This PR does two things:

1 - Update gitignore to include .venv, otherwise pre-commit fails

2 - Fixes the improper bold text in the keys function

This is my first docs PR - if I need to change or update anything, please let me know.

Thanks!

@tekktrik tekktrik linked an issue Sep 15, 2022 that may be closed by this pull request
Documentation rendering improperly for keys function. #40
Closed
tekktrik
tekktrik requested changes Sep 15, 2022
View reviewed changes
Copy link
Member

@tekktrik tekktrik left a comment

Choose a reason for hiding this comment

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

Congrats on your first pull request! Ran it through sphinx, and interestingly found out the following:

adafruit_macropad.py Outdated Show resolved Hide resolved
tekktrik
tekktrik approved these changes Sep 15, 2022
View reviewed changes
Copy link
Member

@tekktrik tekktrik left a comment

Choose a reason for hiding this comment

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

Looks great! Tested out with sphinx as well, and results are as expected. Thanks!

@tekktrik tekktrik merged commit 96f827e into adafruit:main Sep 15, 2022
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Sep 16, 2022
@adafruit-adabot
Automated update by Adabot (adafruit/adabot@84b22d2)
3b9ca10 
Updating https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI to 5.0.5 from 5.0.4:
  > Merge pull request adafruit/Adafruit_CircuitPython_ESP32SPI#175 from rivques/main

Updating https://github.com/adafruit/Adafruit_CircuitPython_TCA8418 to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_TCA8418#5 from tcfranks/main

Updating https://github.com/adafruit/Adafruit_CircuitPython_MacroPad to 2.1.8 from 2.1.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_MacroPad#43 from prcutler/issue40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

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

Documentation rendering improperly for keys function.
2 participants
@prcutler @tekktrik