[DRAFT - DO NOT MERGE] Add documentation for referenced builtins #101
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
microbit-robert
commented
Apr 22, 2024
microbit-robert
commented
Apr 22, 2024
microbit-robert
commented
Apr 22, 2024
| :return: The type of the object passed in. | ||
| """ | ||
| ... | ||
| @overload |
There was a problem hiding this comment.
Overload needs docstring, though a complex signature for our audience.
microbit-robert
commented
Apr 22, 2024
lang/en/typeshed/stdlib/builtins.pyi
Outdated
| :return: The number of times an item appears in the list. | ||
| """ | ||
| ... | ||
| def insert(self, __index: SupportsIndex, __object: _T) -> None: |
There was a problem hiding this comment.
Should we just change signatures like this to:
Suggested change
| def insert(self, __index: SupportsIndex, __object: _T) -> None: | |
| def insert(self, index: SupportsIndex, object: T) -> None: |
|
Class docstrings need more thought, they have mostly been added quickly to ensure that the documentation is shown in the API tab. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
No description provided.