docs: document arguments and returns in DataFrame class #1594
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
marenwestermann
commented
Dec 14, 2024
| @@ -581,8 +584,15 @@ def to_pandas(self) -> pd.DataFrame: | |||
| def write_csv(self, file: str | Path | BytesIO | None = None) -> Any: | |||
There was a problem hiding this comment.
The return type here should be str | None from my understanding. I changed this but then got mypy errors. I started digging into the issue but then decided to leave it like it is for now in favour of getting the documentation done. I can open an issue for it if you like.
MarcoGorelli
approved these changes
Dec 15, 2024
There was a problem hiding this comment.
thanks @marenwestermann - sure, happy to start with these and incrementally add more in multiple PRs, feel free to ship it
marenwestermann
changed the title
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.
What type of PR is this? (check all applicable)
Related issues
Checklist
If you have comments or can explain your changes, please do so below
This is currently work in progress. Feel free to start reviewing. :)