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

Add example to docstrings in rolling.apply #9522

Merged
merged 2 commits into from
Oct 27, 2021

Conversation

isVoid
Copy link
Contributor

@isVoid isVoid commented Oct 25, 2021

Partially address #7850

Currently docstrings of rolling.apply has no example to show case the usage of the API. This PR adds that and also points out that currently args and kwargs is unsupported.

@isVoid isVoid requested a review from a team as a code owner October 25, 2021 23:28
@github-actions github-actions bot added the Python Affects Python cuDF API. label Oct 25, 2021
@isVoid isVoid added non-breaking Non-breaking change doc Documentation Python Affects Python cuDF API. and removed Python Affects Python cuDF API. labels Oct 25, 2021
@isVoid isVoid changed the title Add example for rolling apply Add example to docstrings in rolling.apply Oct 25, 2021
@codecov
Copy link

codecov bot commented Oct 26, 2021

Codecov Report

Merging #9522 (be31e93) into branch-21.12 (ab4bfaa) will decrease coverage by 0.11%.
The diff coverage is n/a.

Impacted file tree graph

@@               Coverage Diff                @@
##           branch-21.12    #9522      +/-   ##
================================================
- Coverage         10.79%   10.67%   -0.12%     
================================================
  Files               116      117       +1     
  Lines             18869    19714     +845     
================================================
+ Hits               2036     2104      +68     
- Misses            16833    17610     +777     
Impacted Files Coverage Δ
python/dask_cudf/dask_cudf/sorting.py 92.90% <0.00%> (-1.21%) ⬇️
python/cudf/cudf/io/csv.py 0.00% <0.00%> (ø)
python/cudf/cudf/io/hdf.py 0.00% <0.00%> (ø)
python/cudf/cudf/io/orc.py 0.00% <0.00%> (ø)
python/cudf/cudf/__init__.py 0.00% <0.00%> (ø)
python/cudf/cudf/_version.py 0.00% <0.00%> (ø)
python/cudf/cudf/core/abc.py 0.00% <0.00%> (ø)
python/cudf/cudf/api/types.py 0.00% <0.00%> (ø)
python/cudf/cudf/io/dlpack.py 0.00% <0.00%> (ø)
python/cudf/cudf/core/frame.py 0.00% <0.00%> (ø)
... and 64 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 72694d2...be31e93. Read the comment docs.

@isVoid
Copy link
Contributor Author

isVoid commented Oct 27, 2021

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 0606325 into rapidsai:branch-21.12 Oct 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation non-breaking Non-breaking change Python Affects Python cuDF API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants