Clarify optional parameters in Airbyte docstrings #30031
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
There were a few inconsistencies in the Airbyte module docstrings which called out required parameters even though those parameters had default values.
josh-fell
commented
Mar 10, 2023
Comment on lines
+57
to
+60
| asynchronous: bool = False, | ||
| api_version: str = "v1", | ||
| wait_seconds: float = 3, | ||
| timeout: float | None = 3600, | ||
| timeout: float = 3600, |
There was a problem hiding this comment.
Cleaned up some typing as well.
ferruzzi
approved these changes
Mar 11, 2023
potiuk
approved these changes
Mar 11, 2023
64 tasks
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.
There were a few inconsistencies in the Airbyte module docstrings which called out required parameters even though those parameters had default values.