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

[REVIEW] Add dtype docs pages and docstrings for cudf specific dtypes #11974

Merged
merged 8 commits into from
Oct 24, 2022

Conversation

galipremsagar
Copy link
Contributor

@galipremsagar galipremsagar commented Oct 22, 2022

Description

Resolves #11605
This PR:

  • Creates docs page entries for cudf.CategoricalDtype, cudf.ListDtype, cudf.StructDtype, cudf.Decimal32Dtype, cudf.Decimal64Dtype, cudf.Decimal128Dtype.
  • Updates docstrings in all of the public APIs of the above dtypes.
  • Links them in the data-types.md page where all supported dtypes are listed as a table.

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@galipremsagar galipremsagar added 2 - In Progress Currently a work in progress doc Documentation non-breaking Non-breaking change labels Oct 22, 2022
@galipremsagar galipremsagar requested a review from a team as a code owner October 22, 2022 04:23
@galipremsagar galipremsagar requested review from vyasr and isVoid October 22, 2022 04:23
@github-actions github-actions bot added the Python Affects Python cuDF API. label Oct 22, 2022
@codecov
Copy link

codecov bot commented Oct 22, 2022

Codecov Report

Base: 87.40% // Head: 86.90% // Decreases project coverage by -0.50% ⚠️

Coverage data is based on head (b4d292b) compared to base (f72c4ce).
Patch has no changes to coverable lines.

❗ Current head b4d292b differs from pull request most recent head 2fc3b3d. Consider uploading reports for the commit 2fc3b3d to get more accurate results

Additional details and impacted files
@@               Coverage Diff                @@
##           branch-22.12   #11974      +/-   ##
================================================
- Coverage         87.40%   86.90%   -0.51%     
================================================
  Files               133      133              
  Lines             21833    21995     +162     
================================================
+ Hits              19084    19114      +30     
- Misses             2749     2881     +132     
Impacted Files Coverage Δ
python/strings_udf/strings_udf/lowering.py 0.00% <0.00%> (-84.40%) ⬇️
python/strings_udf/strings_udf/_typing.py 81.05% <0.00%> (-14.74%) ⬇️
python/strings_udf/strings_udf/__init__.py 84.31% <0.00%> (-12.57%) ⬇️
python/cudf/cudf/io/text.py 91.66% <0.00%> (-8.34%) ⬇️
python/cudf/cudf/core/_base_index.py 82.20% <0.00%> (-3.35%) ⬇️
python/cudf/cudf/core/column/lists.py 92.78% <0.00%> (-0.97%) ⬇️
python/cudf/cudf/testing/dataset_generator.py 72.83% <0.00%> (-0.42%) ⬇️
python/dask_cudf/dask_cudf/backends.py 84.90% <0.00%> (-0.37%) ⬇️
python/cudf/cudf/core/tools/datetimes.py 84.19% <0.00%> (-0.31%) ⬇️
python/dask_cudf/dask_cudf/core.py 73.92% <0.00%> (-0.21%) ⬇️
... and 22 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@galipremsagar galipremsagar changed the title [WIP] Add dtype docs pages [REVIEW] Add dtype docs pages Oct 24, 2022
@galipremsagar galipremsagar changed the title [REVIEW] Add dtype docs pages [REVIEW] Add dtype docs pages and docstrings for cudf specific dtypes Oct 24, 2022
@galipremsagar galipremsagar added 3 - Ready for Review Ready for review by team and removed 2 - In Progress Currently a work in progress labels Oct 24, 2022
Copy link
Contributor

@vyasr vyasr left a comment

Choose a reason for hiding this comment

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

Couple of minor questions, this looks mostly good to go.

python/cudf/cudf/core/dtypes.py Outdated Show resolved Hide resolved
@galipremsagar galipremsagar self-assigned this Oct 24, 2022
@galipremsagar galipremsagar added 5 - Ready to Merge Testing and reviews complete, ready to merge and removed 3 - Ready for Review Ready for review by team labels Oct 24, 2022
@galipremsagar
Copy link
Contributor Author

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 11918ae into rapidsai:branch-22.12 Oct 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Ready to Merge Testing and reviews complete, ready to merge 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.

[DOC] Update data-types page for cudf
2 participants