Skip to content

DOC: fix typos #18980

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
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 reviewed changes
Copy link
Contributor

@dopplershift dopplershift left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution!

@dopplershift dopplershift added this to the v3.4.0 milestone Nov 19, 2020
@jklymak
Copy link
Member

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 reviewed changes
Copy link
Member

@QuLogic QuLogic left a comment

Choose a reason for hiding this comment

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

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
Copy link
Member

Choose a reason for hiding this comment

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

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
Copy link
Member

Choose a reason for hiding this comment

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

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
Copy link
Member

Choose a reason for hiding this comment

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

Ditto.

@QuLogic
Copy link
Member

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 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 previously requested changes Nov 21, 2020
View reviewed changes
Copy link
Member

@tacaswell tacaswell left a comment

Choose a reason for hiding this comment

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

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.

@luzpaz
Copy link
Contributor Author

luzpaz commented Nov 21, 2020 •
edited
Loading

Added requested, thanks @tacaswell.
+ rebased

luzpaz and others added 5 commits November 22, 2020 11:36
@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 <tcaswell@gmail.com>
@luzpaz @tacaswell
Added requested revisions
ae78a00 
Co-authored-by: Thomas A Caswell <tcaswell@gmail.com>
@luzpaz @tacaswell
Added requested revisions
44d2878 
Co-authored-by: Thomas A Caswell <tcaswell@gmail.com>
@luzpaz
Fix typo demonstrated by @QuLogic
8b9b168
@jklymak jklymak dismissed tacaswell’s stale review November 22, 2020 16:51

Done by author

@jklymak jklymak requested a review from tacaswell November 22, 2020 16:51
@timhoffm timhoffm merged commit fed55c6 into matplotlib:master Nov 22, 2020
@timhoffm
Copy link
Member

Thanks @luzpaz!

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

@QuLogic QuLogic QuLogic left review comments

@dopplershift dopplershift dopplershift approved these changes

@jklymak jklymak jklymak approved these changes

@timhoffm timhoffm timhoffm approved these changes

@tacaswell tacaswell Awaiting requested review from tacaswell

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

Successfully merging this pull request may close these issues.
6 participants
@luzpaz @jklymak @QuLogic @timhoffm @tacaswell @dopplershift