Improve dosctrings for DataSources #1808
Open
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
luisaFelixSalles
force-pushed
the
api/api-ref-data-sources_fix_error
branch
from
8b85394
to
765f41d
Compare
BClappe
force-pushed
the
api/api-ref-data-sources_fix_error
branch
from
5fd4060
to
8c05453
Compare
…or' into api/api-ref-data-sources_fix_error # Conflicts: # .github/workflows/ci.yml
PProfizi
commented
Oct 18, 2024
PProfizi
commented
Oct 18, 2024
…or' into api/api-ref-data-sources_fix_error
luisaFelixSalles
force-pushed
the
api/api-ref-data-sources_fix_error
branch
from
d283d5a
to
3eb4157
Compare
PProfizi
commented
Oct 23, 2024
PProfizi
commented
Oct 23, 2024
Comment on lines
+307
to
+309
| key: Optional[str] = "", | ||
| is_domain: Optional[bool] = False, | ||
| domain_id: Optional[int] = 0, |
There was a problem hiding this comment.
I do not think you have to use Optional here as giving them a default value makes them optional already. Plus, using Optional technically means it accepts None as a value, right? Which is not the case here.
There was a problem hiding this comment.
I haven't checked previous code for that in particular but it is worth checking for, because otherwise the user can call these with None and it will not work.
PProfizi
commented
Oct 23, 2024
PProfizi
commented
Oct 23, 2024
PProfizi
commented
Oct 23, 2024
PProfizi
commented
Oct 23, 2024
Comment on lines
+403
to
+404
| key: Optional[str] = "", | ||
| result_key: Optional[str] = "", |
There was a problem hiding this comment.
Again for Optional
PProfizi
commented
Oct 23, 2024
PProfizi
commented
Oct 23, 2024
| def add_upstream(self, upstream_data_sources, result_key=""): | ||
| """Add upstream data sources. | ||
| def add_upstream( | ||
| self, upstream_data_sources: DataSources, result_key: Optional[str] = "" |
There was a problem hiding this comment.
Suggested change
| self, upstream_data_sources: DataSources, result_key: Optional[str] = "" | |
| self, upstream_data_sources: DataSources, result_key: str = "" |
PProfizi
commented
Oct 23, 2024
PProfizi
commented
Oct 23, 2024
PProfizi
commented
Oct 23, 2024
PProfizi
commented
Oct 23, 2024
PProfizi
commented
Oct 23, 2024
PProfizi
commented
Oct 23, 2024
PProfizi
commented
Oct 23, 2024
| >>> | ||
| >>> # Get the path to the main result files of the DataSources object | ||
| >>> my_data_sources.result_files | ||
| [None, None] |
There was a problem hiding this comment.
@luisaFelixSalles that actually looks like a bug?
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Paul Profizi <[email protected]>
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.
No description provided.