-
Notifications
You must be signed in to change notification settings - Fork 915
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
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice bulk fix!
Codecov ReportBase: 87.40% // Head: 86.86% // Decreases project coverage by
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
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. |
76b85c2
to
c5e3801
Compare
@gpucibot merge |
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:
**kwargs
and*args
inIO
readers & writers #12025 (comment)Checklist