Update font documentation for display_text() #50
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current
display_text()
documentation is incorrect in my testing. It is not sufficient to simply provide a font file path string to thefont
argument of this method. You must provide the font in the form of an object which subclassesFontProtocol
or otherwise provides theget_bounding_box()
andget_glyph()
methods. I am proposing this change to the documentation to clear up the usage of this parameter.