Skip to content
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

docs: add examples for dataframe.kurt, dataframe.std, dataframe.count #232

Merged
merged 6 commits into from
Nov 28, 2023

Conversation

Genesis929
Copy link
Collaborator

@Genesis929 Genesis929 commented Nov 27, 2023

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:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

dataframe.kurt: https://screenshot.googleplex.com/9zaLhagKdCNVu4F
dataframe.std: https://screenshot.googleplex.com/5maUCBQozbCsQCy
dataframe.count: https://screenshot.googleplex.com/7Cbgcd5BxXbageq

Fixes #<issue_number_goes_here> 🦕

@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 Nov 27, 2023
@Genesis929 Genesis929 marked this pull request as ready for review November 27, 2023 20:36
@Genesis929 Genesis929 requested review from a team as code owners November 27, 2023 20:36
@Genesis929 Genesis929 requested a review from shobsi November 27, 2023 20:36
<BLANKLINE>
[5 rows x 3 columns]

Calculating the kurtosis value of each column.
Copy link
Contributor

Choose a reason for hiding this comment

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

[nit] probably more appropriate to end the line with ":" instead of ".". Same elsewhere.

Copy link
Contributor

Choose a reason for hiding this comment

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

[nit] Do we also want to add the examples for numeric_only = True? Same for elsewhere.

Copy link
Collaborator Author

@Genesis929 Genesis929 Nov 28, 2023

Choose a reason for hiding this comment

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

For numeric_only=True, in several Pandas APIs I reviewed, it seems that Pandas doesn't really provide an example for this. In the case of BigFrames, most cases numeric_only=True almost does nothing, except it avoids an error that tells the user to set numeric_only=True. So I'm not quite sure if it's necessary.

@Genesis929 Genesis929 merged commit f9c6e72 into main Nov 28, 2023
12 checks passed
@Genesis929 Genesis929 deleted the huanc-stats-docstring-3 branch November 28, 2023 18:48
Genesis929 added a commit that referenced this pull request Dec 12, 2023
…#232)

* docs: add examples for dataframe.kurt, dataframe.std, dataframe.count

* update count example

* update count example

* update examples

* update . to :
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: m Pull request size is medium.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants