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 developer docs for writing tests #11199

Merged
merged 8 commits into from
Nov 3, 2022

Conversation

vyasr
Copy link
Contributor

@vyasr vyasr commented Jul 5, 2022

This PR adds documentation on how Python tests should be written.

Related to #4730. This PR will establish best practices. Follow-up PRs will be needed to implement them.

Resolves #6481.

@vyasr vyasr added 2 - In Progress Currently a work in progress doc Documentation Python Affects Python cuDF API. improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Jul 5, 2022
@vyasr vyasr added this to the CuDF Python Refactoring milestone Jul 5, 2022
@vyasr vyasr self-assigned this Jul 5, 2022
@github-actions github-actions bot removed the Python Affects Python cuDF API. label Jul 5, 2022
@vyasr vyasr removed the improvement Improvement / enhancement to an existing function label Jul 5, 2022
Copy link
Contributor

@wence- wence- left a comment

Choose a reason for hiding this comment

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

Minor quibble

docs/cudf/source/developer_guide/testing.md Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Jul 18, 2022

Codecov Report

Base: 87.47% // Head: 86.86% // Decreases project coverage by -0.60% ⚠️

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

❗ Current head f469142 differs from pull request most recent head 0d622b5. Consider uploading reports for the commit 0d622b5 to get more accurate results

Additional details and impacted files
@@               Coverage Diff                @@
##           branch-22.12   #11199      +/-   ##
================================================
- Coverage         87.47%   86.86%   -0.61%     
================================================
  Files               133      135       +2     
  Lines             21826    21985     +159     
================================================
+ Hits              19093    19098       +5     
- Misses             2733     2887     +154     
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%> (-13.69%) ⬇️
python/cudf/cudf/io/text.py 91.66% <0.00%> (-8.34%) ⬇️
python/cudf/cudf/core/_base_index.py 81.28% <0.00%> (-4.27%) ⬇️
python/cudf/cudf/io/json.py 92.06% <0.00%> (-2.68%) ⬇️
python/cudf/cudf/utils/utils.py 89.91% <0.00%> (-0.69%) ⬇️
python/dask_cudf/dask_cudf/core.py 73.72% <0.00%> (-0.41%) ⬇️
python/cudf/cudf/io/parquet.py 90.45% <0.00%> (-0.39%) ⬇️
python/dask_cudf/dask_cudf/backends.py 84.90% <0.00%> (-0.37%) ⬇️
python/cudf/cudf/core/dataframe.py 93.63% <0.00%> (-0.10%) ⬇️
... and 30 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.

rapids-bot bot pushed a commit that referenced this pull request Aug 4, 2022
This PR adds a primary developer guide for Python. It provides a more complete and informative landing page for new developers. When #11217, #11199, and #11122 are merged, they will all be linked from this page to provide a complete set of developer documentation.

There is one main point of discussion that I would like reviewer comments on, and that is the section on directory and file organization. How do we want that aspect of cuDF to look?

Authors:
  - Vyas Ramasubramani (https://github.com/vyasr)

Approvers:
  - Matthew Roeschke (https://github.com/mroeschke)
  - Lawrence Mitchell (https://github.com/wence-)
  - Ashwin Srinath (https://github.com/shwina)

URL: #11235
@github-actions
Copy link

This PR has been labeled inactive-30d due to no recent activity in the past 30 days. Please close this PR if it is no longer required. Otherwise, please respond with a comment indicating any updates. This PR will be labeled inactive-90d if there is no activity in the next 60 days.

@vyasr vyasr added 3 - Ready for Review Ready for review by team Python Affects Python cuDF API. and removed inactive-30d libcudf Affects libcudf (C++/CUDA) code. labels Oct 26, 2022
@vyasr vyasr marked this pull request as ready for review October 26, 2022 23:50
@vyasr vyasr requested review from wence-, shwina and mroeschke October 26, 2022 23:51
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
Copy link
Contributor

@wence- wence- left a comment

Choose a reason for hiding this comment

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

Some minor comments, but overall looks good, thanks!

docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
@vyasr vyasr requested review from bdice and wence- November 1, 2022 19:19
@github-actions github-actions bot removed the Python Affects Python cuDF API. label Nov 1, 2022
Copy link
Contributor

@bdice bdice left a comment

Choose a reason for hiding this comment

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

Minor changes suggested, otherwise LGTM.

docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
@vyasr
Copy link
Contributor Author

vyasr commented Nov 1, 2022

rerun tests

Copy link
Contributor

@wence- wence- left a comment

Choose a reason for hiding this comment

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

Very minor nit, but overall great! Thanks!

docs/cudf/source/developer_guide/testing.md Outdated Show resolved Hide resolved
@vyasr
Copy link
Contributor Author

vyasr commented Nov 2, 2022

rerun tests

Copy link
Contributor

@shwina shwina left a comment

Choose a reason for hiding this comment

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

LGTM w/ small suggestion/question.

@vyasr
Copy link
Contributor Author

vyasr commented Nov 2, 2022

rerun tests

@vyasr
Copy link
Contributor Author

vyasr commented Nov 3, 2022

@gpucibot merge

@rapids-bot rapids-bot bot merged commit eaa0706 into rapidsai:branch-22.12 Nov 3, 2022
@vyasr vyasr deleted the docs/python_testing branch November 3, 2022 00:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Ready for Review Ready for review by team doc Documentation non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DISCUSS] cuDF internal/developer documentation
5 participants