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

Remove smart quotes from all docstrings. #12035

Merged
merged 3 commits into from
Nov 1, 2022

Conversation

bdice
Copy link
Contributor

@bdice bdice commented Nov 1, 2022

Description

This PR removes all "smart quotes" from the library by enforcing a pre-commit hook.

Smart quotes typically arise from copying rendered docstrings from Pandas, because Sphinx automatically transforms straight quotes into smart quotes when rendering the docs as HTML. However, the use of smart quotes is undesirable in code, and makes it difficult to do find-replace transformations if straight and smart quotes are mixed.

I have made suggestions to fix this several times before, so I am making the suggestions more permanent and automatically enforceable via a pre-commit style check:

Checklist

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

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@bdice bdice self-assigned this Nov 1, 2022
@github-actions github-actions bot added the Python Affects Python cuDF API. label Nov 1, 2022
@bdice bdice added code quality improvement Improvement / enhancement to an existing function non-breaking Non-breaking change and removed Python Affects Python cuDF API. labels Nov 1, 2022
@bdice bdice changed the title Fix smartquotes Remove smart quotes from all docstrings. Nov 1, 2022
@github-actions github-actions bot added the Python Affects Python cuDF API. label Nov 1, 2022
@bdice bdice marked this pull request as ready for review November 1, 2022 14:12
@bdice bdice requested a review from a team as a code owner November 1, 2022 14:12
@bdice bdice requested review from shwina and galipremsagar November 1, 2022 14:12
Copy link
Contributor

@galipremsagar galipremsagar left a comment

Choose a reason for hiding this comment

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

Nice bulk fix!

@galipremsagar galipremsagar added the 5 - Ready to Merge Testing and reviews complete, ready to merge label Nov 1, 2022
@codecov
Copy link

codecov bot commented Nov 1, 2022

Codecov Report

Base: 87.40% // Head: 86.86% // Decreases project coverage by -0.53% ⚠️

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

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

Additional details and impacted files
@@               Coverage Diff                @@
##           branch-22.12   #12035      +/-   ##
================================================
- Coverage         87.40%   86.86%   -0.54%     
================================================
  Files               133      133              
  Lines             21833    22003     +170     
================================================
+ Hits              19084    19114      +30     
- Misses             2749     2889     +140     
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 81.28% <0.00%> (-4.27%) ⬇️
python/cudf/cudf/io/json.py 92.06% <0.00%> (-2.68%) ⬇️
python/cudf/cudf/core/column/lists.py 92.78% <0.00%> (-0.97%) ⬇️
python/cudf/cudf/utils/utils.py 89.91% <0.00%> (-0.69%) ⬇️
python/cudf/cudf/testing/dataset_generator.py 72.83% <0.00%> (-0.42%) ⬇️
python/dask_cudf/dask_cudf/core.py 73.72% <0.00%> (-0.41%) ⬇️
... and 29 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.

@bdice
Copy link
Contributor Author

bdice commented Nov 1, 2022

@gpucibot merge

@rapids-bot rapids-bot bot merged commit f19bdbc into rapidsai:branch-22.12 Nov 1, 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 improvement Improvement / enhancement to an existing function 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