chore: type-check friendlier exports #1407
Merged
Conversation
This file contains 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
wjones127
reviewed
May 29, 2023
Comment on lines
100
to
+107
| name: str | ||
| """The field name.""" | ||
| type: DataType | ||
| """The field data type.""" | ||
| nullable: bool | ||
| """The field nullability.""" | ||
| metadata: Dict[str, Any] | ||
| """The field metadata.""" |
There was a problem hiding this comment.
Does this show up in the API reference correctly? I had never seen this syntax before.
There was a problem hiding this comment.
Checked again, and it seems to be valid.
wjones127
approved these changes
May 29, 2023
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.
Description
Some static type checker (i.e. pyright) consider imports as internal to the module unless explicitly stated otherwise - by adding it to
__all__or using the "redundant alias" (not sure that's an official term 😆) form. I opted for the second, as I think it looks a bit nicer..We were also exporting
RawDeltaTableat the root, which I thogtht would be an internal class, that we do not want to expose to users?Took the opportunity to also add a few more docstrings.
Related Issue(s)
Documentation