better document these type-checking items #9885
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
commented
Dec 11, 2024
jepler
commented
elpekenin
reviewed
Dec 11, 2024
| //| import memorymap | ||
| //| | ||
| //| FifoType = Literal["auto", "txrx", "tx", "rx", "txput", "txget", "putget"] | ||
| //| """A type representing of the strings ``"auto"``, ``"txrx"``, ``"tx"``, ``"rx"``, ``"txput"``, txget" or ``"putget"``. These values are supported on RP2350. For type-checking only, not actually defined in CircuitPython.""" |
There was a problem hiding this comment.
Tiny typo
Suggested change
| //| """A type representing of the strings ``"auto"``, ``"txrx"``, ``"tx"``, ``"rx"``, ``"txput"``, txget" or ``"putget"``. These values are supported on RP2350. For type-checking only, not actually defined in CircuitPython.""" | |
| //| """A type representing of the strings ``"auto"``, ``"txrx"``, ``"tx"``, ``"rx"``, ``"txput"``, ``"txget"`` or ``"putget"``. These values are supported on RP2350. For type-checking only, not actually defined in CircuitPython.""" |
Collaborator
There was a problem hiding this comment.
Also should be one of the strings, not of the strings.
Author
There was a problem hiding this comment.
thanks, I totally overlooked it including in the rendered docs. fixed now.
dhalbert
approved these changes
Dec 11, 2024
Collaborator
dhalbert
left a comment
dhalbert
left a comment
There was a problem hiding this comment.
I looked at the doc build output and it looks good!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.