The Wayback Machine - https://web.archive.org/web/20210828113813/https://github.com/matplotlib/matplotlib/pull/18980
Skip to content

/ matplotlib

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

Jump to bottom

DOC: fix typos #18980

Merged
merged 5 commits into from Nov 22, 2020
Merged

DOC: fix typos #18980

merged 5 commits into from Nov 22, 2020

Conversation

@luzpaz
Copy link
Contributor

@luzpaz luzpaz commented Nov 19, 2020

Found using codespell v2.0.dev

codespell -q 3 -S ./extern,./doc/users/credits.rst,./doc/api/prev_api_changes,./doc/users/prev_whats_new -L afe,ans,axises,ba,coo,flate,fo,hist,inout,ment,nd,offsetp,oly,ot,te,thisy,vas,whis,wit
@dopplershift
dopplershift approved these changes Nov 19, 2020
View changes
Copy link
Contributor

@dopplershift dopplershift left a comment

Thanks for the contribution!
@dopplershift dopplershift added this to the v3.4.0 milestone Nov 19, 2020
@jklymak
Copy link
Contributor

@jklymak jklymak commented Nov 19, 2020

We periodically get PRs like this, which is great, but they are disruptive in that they hit a bunch of files trivially. Have we given any thought to just running codespell as part of CI, just like we run flake8?

@QuLogic
QuLogic reviewed Nov 19, 2020
View changes
Copy link
Member

@QuLogic QuLogic left a comment

Can you also fix this new typo?
https://github.com/matplotlib/matplotlib/pull/18976/files#diff-33fca2ac0f7a278ffa15904a36c488500a9a4f594094e4bbffb1a10d7e9948afR30
examples/axisartist/demo_curvelinear_grid2.py Outdated
@@ -1,6 +1,6 @@
"""
======================
Demo Curvelinear Grid2
Demo Curvilinear Grid2

This comment has been minimized.

Sign in to view
@QuLogic

QuLogic Nov 19, 2020
Member

This one is on purpose; see the filename and classes used. Maybe it should be CurveLinear in the title instead, though?

tutorials/toolkits/axisartist.py Outdated
@@ -121,7 +121,7 @@
:align: center
:scale: 50
Demo Curvelinear Grid
Demo Curvilinear Grid

This comment has been minimized.

Sign in to view
@QuLogic

QuLogic Nov 19, 2020
Member

Ditto

tutorials/toolkits/axisartist.py Outdated
@@ -566,7 +566,7 @@ def inv_tr(x, y):
:align: center
:scale: 50
Demo Curvelinear Grid
Demo Curvilinear Grid

This comment has been minimized.

Sign in to view
@QuLogic

QuLogic Nov 19, 2020
Member

Ditto.

@QuLogic
Copy link
Member

@QuLogic QuLogic commented Nov 19, 2020

The trouble with running it in CI is that there are a lot of false positives; I'm sure @luzpaz had to spend a while cherry picking the bits that are actually errors.

Possibly we could use reviewdog to limit the results to the diff, if codespell doesn't have a way to do that.

@luzpaz
Copy link
Contributor Author

@luzpaz luzpaz commented Nov 20, 2020

The trouble with running it in CI is that there are a lot of false positives; I'm sure @luzpaz had to spend a while cherry picking the bits that are actually errors.
Possibly we could use reviewdog to limit the results to the diff, if codespell doesn't have a way to do that.

Indeed. But each time I added them to to the -L flag list. Codespell can be run specifically on the diff. I've seen it but not remembering exactly now.

@tacaswell
tacaswell reviewed Nov 21, 2020
View changes
Copy link
Member

@tacaswell tacaswell left a comment

I agree with @QuLogic 's comment about CureveLinear vs Curvilinear. For better or worse the class name is CurveLinear and we should match that in the text.

Anyone can clear this review.
examples/axisartist/demo_curvelinear_grid2.py Outdated Show resolved Hide resolved
tutorials/toolkits/axisartist.py Outdated Show resolved Hide resolved
tutorials/toolkits/axisartist.py Outdated Show resolved Hide resolved
@luzpaz luzpaz force-pushed the luzpaz:typos branch from 86b77b1 to ccb4065 Nov 21, 2020
@luzpaz
Copy link
Contributor Author

@luzpaz luzpaz commented Nov 21, 2020 •
edited

Added requested, thanks @tacaswell.
+ rebased

luzpaz and others added 5 commits Nov 19, 2020
@luzpaz
DOC: fix typos
7af56f5 
Found using `codespell v2.0.dev`  
```
codespell -q 3 -S ./extern,./doc/users/credits.rst,./doc/api/prev_api_changes,./doc/users/prev_whats_new -L afe,ans,axises,ba,coo,flate,fo,hist,inout,ment,nd,offsetp,oly,ot,te,thisy,vas,whis,wit
```
@luzpaz @tacaswell
Added requested revisions
02e9fa5 
Co-authored-by: Thomas A Caswell <[email protected]>
@luzpaz @tacaswell
Added requested revisions
ae78a00 
Co-authored-by: Thomas A Caswell <[email protected]>
@luzpaz @tacaswell
Added requested revisions
44d2878 
Co-authored-by: Thomas A Caswell <[email protected]>
@luzpaz
Fix typo demonstrated by @QuLogic
8b9b168
@luzpaz luzpaz force-pushed the luzpaz:typos branch from a22d7e8 to 8b9b168 Nov 22, 2020
@jklymak
jklymak approved these changes Nov 22, 2020
View changes
@jklymak jklymak dismissed tacaswell’s stale review Nov 22, 2020

Done by author

@jklymak jklymak requested a review from tacaswell Nov 22, 2020
@timhoffm
timhoffm approved these changes Nov 22, 2020
View changes
@timhoffm timhoffm merged commit fed55c6 into matplotlib:master Nov 22, 2020
21 checks passed
21 checks passed
@github-actions
flake8
Details
@github-actions
eslint
Details
@lgtm-com
LGTM analysis: JavaScript No code changes detected
Details
@lgtm-com
LGTM analysis: Python No new or fixed alerts
Details
ci/circleci: docs-python37 Your tests passed on CircleCI!
Details
@github-actions
ci/circleci: docs-python37 artifact Link to 0/doc/build/html/index.html
Details
ci/circleci: docs-python38 Your tests passed on CircleCI!
Details
@github-actions
ci/circleci: docs-python38 artifact Link to 0/doc/build/html/index.html
Details
ci/circleci: docs-python38-min Your tests passed on CircleCI!
Details
@codecov
codecov/patch Coverage not affected when comparing 3b9ec68...8b9b168
Details
@codecov
codecov/project/library 74.08% (target 50.00%)
Details
@codecov
codecov/project/tests 98.03% (+0.00%) compared to 3b9ec68
Details
@appveyor
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
@azure-pipelines
matplotlib.matplotlib Build #20201122.5 succeeded
Details
@azure-pipelines
matplotlib.matplotlib (Job Linux_py37) Job Linux_py37 succeeded
Details
@azure-pipelines
matplotlib.matplotlib (Job Linux_py38) Job Linux_py38 succeeded
Details
@azure-pipelines
matplotlib.matplotlib (Job Windows_py37) Job Windows_py37 succeeded
Details
@azure-pipelines
matplotlib.matplotlib (Job Windows_py38) Job Windows_py38 succeeded
Details
@azure-pipelines
matplotlib.matplotlib (Job Windows_pyPre) Job Windows_pyPre succeeded
Details
@azure-pipelines
matplotlib.matplotlib (Job macOS_py37) Job macOS_py37 succeeded
Details
@azure-pipelines
matplotlib.matplotlib (Job macOS_py38) Job macOS_py38 succeeded
Details
@timhoffm
Copy link
Member

@timhoffm timhoffm commented Nov 22, 2020

Thanks @luzpaz!

@luzpaz luzpaz deleted the luzpaz:typos branch Nov 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuLogic QuLogic

@dopplershift dopplershift

@jklymak jklymak

@timhoffm timhoffm

@tacaswell tacaswell

Assignees
No one assigned
Labels
Maintenance
Projects
None yet
Milestone
v3.4.0
Linked issues

Successfully merging this pull request may close these issues.

None yet

6 participants
@luzpaz @jklymak @QuLogic @timhoffm @tacaswell @dopplershift