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.

Sign up for GitHub

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

Jump to bottom

Enable pydocstyle rules involving quotes #10748

Merged
merged 3 commits into from
Apr 29, 2022
Merged

Enable pydocstyle rules involving quotes #10748

merged 3 commits into from
Apr 29, 2022

Conversation

vyasr
Copy link
Contributor

@vyasr vyasr commented Apr 27, 2022 •
edited
Loading

This PR enables D30* errors for pydocstyle. It also sets up the ignore-decorators configuration so that future PRs involving D10* errors will treat docutils decorators appropriately. Contributes to #10711.

@vyasr vyasr added 3 - Ready for Review Ready for review by team doc Documentation Python Affects Python cuDF API. non-breaking Non-breaking change labels Apr 27, 2022
@vyasr vyasr requested a review from a team as a code owner April 27, 2022 14:50
@vyasr vyasr self-assigned this Apr 27, 2022
@vyasr vyasr requested review from trxcllnt and bdice April 27, 2022 14:50
@codecov
Copy link

codecov bot commented Apr 27, 2022 •
edited
Loading

Codecov Report

Merging #10748 (4347c9c) into branch-22.06 (dc1435b) will increase coverage by 0.02%.
The diff coverage is n/a.

❗ Current head 4347c9c differs from pull request most recent head 13f6a07. Consider uploading reports for the commit 13f6a07 to get more accurate results

@@               Coverage Diff                @@
##           branch-22.06   #10748      +/-   ##
================================================
+ Coverage         86.37%   86.39%   +0.02%     
================================================
  Files               142      142              
  Lines             22306    22306              
================================================
+ Hits              19266    19272       +6     
+ Misses             3040     3034       -6
Impacted Files Coverage Δ
python/cudf/cudf/comm/gpuarrow.py 79.76% <ø> (ø)
python/cudf/cudf/core/column/string.py 89.21% <ø> (+0.12%) ⬆️
python/cudf/cudf/core/frame.py 93.41% <ø> (ø)
python/cudf/cudf/core/series.py 95.16% <ø> (ø)
python/cudf/cudf/core/groupby/groupby.py 91.68% <0.00%> (+0.23%) ⬆️
python/cudf/cudf/core/tools/datetimes.py 84.49% <0.00%> (+0.30%) ⬆️
python/cudf/cudf/core/column/lists.py 92.91% <0.00%> (+1.25%) ⬆️

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 dc1435b...13f6a07. Read the comment docs.

bdice
bdice approved these changes Apr 27, 2022
View reviewed changes
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.

Great work. For a next step after this PR, I'd like to reduce the exclusions before adding more rules. We should try to enforce our style rules uniformly for dask_cudf, cudf_kafka, custreamz, and python/cudf/cudf/tests.

@vyasr
Copy link
Contributor Author

vyasr commented Apr 29, 2022

@bdice I am very much on board with trying to synchronize across all of the different cudf packages and reduce the number of configuration files. I don't think that there is a particular order in which we need to do these things, I suspect that we can progress to this goal incrementally in any order without running into many problems. The only issue that I'd foresee is that if multiple people work on this we'll need coordination to avoid conflicts.

@vyasr
Copy link
Contributor Author

vyasr commented Apr 29, 2022

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 3c208a6 into rapidsai:branch-22.06 Apr 29, 2022
@vyasr
Copy link
Contributor Author

vyasr commented Apr 29, 2022

@bdice I opened #10758 to discuss this further.

@bdice bdice mentioned this pull request Apr 29, 2022
Merged
rapids-bot bot pushed a commit that referenced this pull request Apr 29, 2022
@bdice
Enable pydocstyle for all packages. (#10759)
15e4982 
Follow-up to #10748 to enable the base pydocstyle rules on all Python packages (`dask_cudf`, `cudf_kafka`, `custreamz`) and test files. Contributes to #10711, #10758.

Authors:
  - Bradley Dice (https://github.com/bdice)

Approvers:
  - GALI PREM SAGAR (https://github.com/galipremsagar)

URL: #10759
@vyasr vyasr deleted the feature/pydocstyle_quotes branch July 13, 2022 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bdice bdice bdice approved these changes

@trxcllnt trxcllnt Awaiting requested review from trxcllnt trxcllnt is a code owner automatically assigned from rapidsai/cudf-python-codeowners

Assignees

@vyasr vyasr

Labels
3 - Ready for Review Ready for review by team doc Documentation non-breaking Non-breaking change Python Affects Python cuDF API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@vyasr @bdice