update TileGrid docstrings to include Shape #5280
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jepler
approved these changes
Sep 1, 2021
|
I am not aware of any other places where both Bitmap and Shape are valid argument types. I'm glad you mentioned this though, I didn't know that file existed. |
|
Late to the party on this one, should the Union also include |
|
@lesamouraipourpre good catch, yes it should include You want to make a PR for that one? If not I can work on that later on tonight. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In order to use
displayio.Shapeyou must pass it to a TileGrid as the first parameter. This updates the docstrings to includeShapeas one of the valid types for that parameter so that usages will not generate a warning from the IDE when you have circuitpython-stubs installed.