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

Update font documentation for display_text() #50

Merged

Conversation

haugenmitch
Copy link
Contributor

The current display_text() documentation is incorrect in my testing. It is not sufficient to simply provide a font file path string to the font argument of this method. You must provide the font in the form of an object which subclasses FontProtocol or otherwise provides the get_bounding_box() and get_glyph() methods. I am proposing this change to the documentation to clear up the usage of this parameter.

Copy link
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

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

Thank you!

@tannewt
Copy link
Member

tannewt commented Nov 9, 2023

Looks like the underlying text display library may have evolved out from under this library.

@tannewt tannewt merged commit 8c8c297 into adafruit:main Nov 9, 2023
1 check passed
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Nov 10, 2023
Updating https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font to 2.1.0 from 2.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_Bitmap_Font#65 from RetiredWizard/main

Updating https://github.com/adafruit/Adafruit_CircuitPython_Display_Shapes to 2.7.3 from 2.7.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_Display_Shapes#66 from adafruit/dhalbert-patch-1

Updating https://github.com/adafruit/Adafruit_CircuitPython_Display_Text to 3.0.5 from 3.0.4:
  > Merge pull request adafruit/Adafruit_CircuitPython_Display_Text#199 from adafruit/dhalbert-patch-1

Updating https://github.com/adafruit/Adafruit_CircuitPython_FunHouse to 2.2.1 from 2.2.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_FunHouse#42 from adafruit/dhalbert-patch-1

Updating https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad to 1.20.1 from 1.20.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_ImageLoad#77 from adafruit/dhalbert-patch-1

Updating https://github.com/adafruit/Adafruit_CircuitPython_MacroPad to 2.3.2 from 2.3.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_MacroPad#50 from haugenmitch/update-display_text-documentation
  > Merge pull request adafruit/Adafruit_CircuitPython_MacroPad#51 from adafruit/dhalbert-patch-1

Updating https://github.com/adafruit/Adafruit_CircuitPython_miniQR to 2.1.0 from 2.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_miniQR#25 from prcutler/root-group-fix

Updating https://github.com/adafruit/Adafruit_CircuitPython_Bundle/circuitpython_library_list.md to NA from NA:
  > Updated download stats for the libraries
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.

2 participants