Skip to content

docs: add docs for DataFrame and Series dunder methods #562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Apr 12, 2024

Conversation

shobsi
Copy link
Contributor

@shobsi shobsi commented Apr 2, 2024

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

Fixes internal issue 304747371 🦕

@shobsi shobsi requested review from a team as code owners April 2, 2024 00:49
@shobsi shobsi requested a review from tswast April 2, 2024 00:49
@product-auto-label product-auto-label bot added size: m Pull request size is medium. api: bigquery Issues related to the googleapis/python-bigquery-dataframes API. labels Apr 2, 2024
@product-auto-label product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Apr 3, 2024
@product-auto-label product-auto-label bot added size: xl Pull request size is extra large. and removed size: l Pull request size is large. labels Apr 4, 2024
@shobsi shobsi changed the title docs: add docs for DataFrame dunder methods docs: add docs for DataFrame and Series dunder methods Apr 4, 2024
Copy link
Collaborator

@tswast tswast left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Were any of these docstring or examples derived from the pandas documentation? If so, they need to be moved to third_party.

@shobsi
Copy link
Contributor Author

shobsi commented Apr 4, 2024

Were any of these docstring or examples derived from the pandas documentation? If so, they need to be moved to third_party.

DataFrame.__array__ is one case that could be debated. There is no pandas DataFrame.__array__ documentation, so I put BigFrames DataFrame.__array__ directly. There is pandas Series.__array__, so I added BigFrames Series.__array__ in third party. For consistency I kept wording of DataFrame.__array__ close to Series.__array__.

Similarly for bunch of methods like __eq__, __ne__, __gt__ ... there is no pandas documentation but I am adding docstring with code samples directly in our classes which are worded similar to their public versions (eq, ne, gt respectively) for consistency.

Is that acceptable?

@tswast
Copy link
Collaborator

tswast commented Apr 10, 2024

adding docstring with code samples directly in our classes which are worded similar to their public versions

Anything derived from third-party content needs to be in the third-party directory.

@shobsi shobsi merged commit 8fc26c4 into main Apr 12, 2024
16 checks passed
@shobsi shobsi deleted the shobs-docs-df-dunders branch April 12, 2024 05:27
@shobsi
Copy link
Contributor Author

shobsi commented Apr 12, 2024

adding docstring with code samples directly in our classes which are worded similar to their public versions

Anything derived from third-party content needs to be in the third-party directory.

Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: bigquery Issues related to the googleapis/python-bigquery-dataframes API. size: xl Pull request size is extra large.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants