Fix spelling errors #22964

jsoref · 2022-05-03T08:17:34Z

PR Summary

This PR corrects misspellings identified by the check-spelling action.

The misspellings have been reported at jsoref@5ccdace#commitcomment-72743863

The action reports that the changes in this PR would make it happy: jsoref@d4a8b5d

Note: this PR does not include the action. If you're interested in running a spell check on every PR and push, that can be offered separately.

Spelling errors can often mask bugs. User facing errors also hinder the user experience.

PR Checklist

Tests and Styling

Has pytest style unit tests (and pytest passes).
Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

New features are documented, with examples if plot related.
New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
Documentation is sphinx and numpydoc compliant (the docs should build without error).

github-actions

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

jsoref

The vast majority of spelling corrections were suggested by Google Sheets.
All fault is mine

jsoref · 2022-05-03T08:19:43Z

doc/api/next_api_changes/behavior/22229-TAC.rst

-When iterating over the contents of the the dynamically generated proxy lists
+When iterating over the contents of the dynamically generated proxy lists


This isn't technically a misspelling. I'm moderately confident in the word undoublings I've made, but I've only recently started performing this additional change...

jsoref · 2022-05-03T08:19:58Z

doc/api/prev_api_changes/api_changes_0.70.rst

-   Removed definct set_measurement in wx toolbar
+   Removed defunct set_measurement in wx toolbar


jsoref · 2022-05-03T08:21:16Z

doc/api/prev_api_changes/api_changes_3.5.0/deprecations.rst

-``dt = np.datetim64(e*1e6, 'us')``.
+``dt = np.datetime64(e*1e6, 'us')``.


doc/conf.py

jsoref · 2022-05-03T08:24:37Z

doc/users/installing/index.rst

-See the Ananconda web page for installation support.
+See the Anaconda web page for installation support.


lib/matplotlib/tests/test_text.py

lib/matplotlib/tests/test_widgets.py

lib/matplotlib/transforms.py

lib/mpl_toolkits/axisartist/axislines.py

jsoref · 2022-05-03T09:02:34Z

src/_tkagg.cpp

- * module by dlsym() only if it is really located in the given modile,
+ * module by dlsym() only if it is really located in the given module,


timhoffm

Thanks for helping to improve Matplotlib!

I suggest to squash all changes into a single commit "Fix spelling errors" when all is sorted out.

timhoffm · 2022-05-03T15:56:25Z

doc/users/prev_whats_new/changelog.rst

-    Changed the fmt kwarg of errorbar to support the the mpl convention that
+    Changed the fmt kwarg of errorbar to support the mpl convention that


Fixing spelling errors in changelogs is ok.

doc/users/prev_whats_new/changelog.rst

doc/users/prev_whats_new/github_stats_3.0.0.rst

extern/agg24-svn/include/agg_array.h

lib/matplotlib/transforms.py

doc/users/prev_whats_new/changelog.rst

lib/matplotlib/testing/__init__.py

doc/users/prev_whats_new/changelog.rst

doc/conf.py

doc/api/prev_api_changes/api_changes_3.1.0.rst

greglucas · 2022-05-04T14:06:40Z

It is interesting that this found so many more issues than codespell in #22777. Is there a reference for what the difference is with this approach versus codespell?

I'd additionally suggest that major spelling updates and other formatting changes get added to the blame ignore file once squashed down to one commit: https://github.com/matplotlib/matplotlib/blob/main/.git-blame-ignore-revs

jsoref · 2022-05-04T14:27:25Z

codespell has different design goals. It targets common misspellings made by programmers.

check-spelling is domain agnostic (although it doesn't really support languages other than English) in that it would be just as happy to work on a document destined for a scientific journal or someone's script for a theater production. "All" it does is parse text looking for words and then check them against the configured dictionaries.

I personally take that output and then ask Google (Sheets) to suggest word corrections. Google has a much larger sense of corrections than the average person. -- I use the to generate commits and iterate through the tooling. I hide that iteration from projects in an ancillary fork, but you can see the steps https://github.com/check-spelling/matplotlib/actions if you're curious. As I'm looking through the spreadsheet of words with Google Sheets, if something jumps out at me, I'll correct that was well, or as I look at a correction as applied and spot something else, I might fix that too.

"All" is a vast simplification, check spelling has a number of heuristics for various things including detecting files to ignore, supplemental patterns to detect, suggesting supplemental dictionaries to use, ...

So far I haven't looked into building a table of automatic corrections a la codespell, although I do have notes in forbidden patterns to explain to a reader why a pattern might trip. But I know that a number of people have responded to my PRs by suggesting additions to codespell.

jsoref · 2022-05-04T14:33:00Z

I'd additionally suggest that major spelling updates and other formatting changes get added to the blame ignore file once squashed down to one commit: https://github.com/matplotlib/matplotlib/blob/main/.git-blame-ignore-revs

It looks like this project uses merges, which means I should be able to squash the spelling fixes and then add a second commit that updates the blame ignore revs file.

I'll do that once people tell me they're happy with the changes.

jklymak · 2022-05-18T08:25:33Z

Moved to draft until the comments above are dealt with and the rebase is done.

oscargus · 2022-05-18T08:54:52Z

I am happy with the changes, so please go ahead and rebase and add the git blame-stuff.

greglucas

Looks good to me. There are a few additional mistakes caught by @QuLogic that would be good to address as well. In particular, the note about keeping the previous "bad" spelling in the changelog.

jklymak · 2022-05-24T11:02:10Z

I don't think the issues brought up by @QuLogic have been addressed - moved back to draft

timhoffm · 2022-05-24T20:21:54Z

Thanks @jsoref and congratulations on your first contribution to Matplotlib! We hope to see you back.

github-actions bot reviewed May 3, 2022

View reviewed changes

jsoref commented May 3, 2022

View reviewed changes

timhoffm reviewed May 3, 2022

View reviewed changes

jsoref force-pushed the spelling branch 3 times, most recently from 5484da1 to cfe8032 Compare May 4, 2022 01:17

jsoref requested a review from timhoffm May 4, 2022 01:18

tacaswell added this to the v3.6.0 milestone May 4, 2022

QuLogic reviewed May 4, 2022

View reviewed changes

matthewfeickert mentioned this pull request May 4, 2022

DEV: Add codespell to pre-commit hooks #22777

Merged

jklymak added the status: needs revision label May 18, 2022

jklymak marked this pull request as draft May 18, 2022 08:24

jsoref force-pushed the spelling branch from cfe8032 to fec6157 Compare May 18, 2022 21:37

jsoref marked this pull request as ready for review May 18, 2022 21:37

greglucas approved these changes May 20, 2022

View reviewed changes

jklymak marked this pull request as draft May 24, 2022 11:01

jsoref added 2 commits May 24, 2022 10:31

Fix spelling errors

686c9e5

DEV: ignore spelling fixes

a831f0a

jsoref force-pushed the spelling branch from fec6157 to a831f0a Compare May 24, 2022 14:33

jsoref marked this pull request as ready for review May 24, 2022 14:34

timhoffm approved these changes May 24, 2022

View reviewed changes

timhoffm removed the status: needs revision label May 24, 2022

timhoffm merged commit e49d6b6 into matplotlib:main May 24, 2022

jsoref deleted the spelling branch May 24, 2022 21:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix spelling errors #22964

Fix spelling errors #22964

jsoref commented May 3, 2022

github-actions bot left a comment

jsoref left a comment

jsoref May 3, 2022

jsoref May 3, 2022

jsoref May 3, 2022

jsoref May 3, 2022

jsoref May 3, 2022

timhoffm left a comment

timhoffm May 3, 2022

greglucas commented May 4, 2022

jsoref commented May 4, 2022

jsoref commented May 4, 2022

jklymak commented May 18, 2022

oscargus commented May 18, 2022

greglucas left a comment

jklymak commented May 24, 2022

timhoffm commented May 24, 2022

		When iterating over the contents of the the dynamically generated proxy lists
		When iterating over the contents of the dynamically generated proxy lists

		Removed definct set_measurement in wx toolbar
		Removed defunct set_measurement in wx toolbar

		``dt = np.datetim64(e*1e6, 'us')``.
		``dt = np.datetime64(e*1e6, 'us')``.

		See the Ananconda web page for installation support.
		See the Anaconda web page for installation support.

		* module by dlsym() only if it is really located in the given modile,
		* module by dlsym() only if it is really located in the given module,

		Changed the fmt kwarg of errorbar to support the the mpl convention that
		Changed the fmt kwarg of errorbar to support the mpl convention that

Fix spelling errors #22964

Fix spelling errors #22964

Conversation

jsoref commented May 3, 2022

PR Summary

PR Checklist

github-actions bot left a comment

Choose a reason for hiding this comment

jsoref left a comment

Choose a reason for hiding this comment

jsoref May 3, 2022

Choose a reason for hiding this comment

jsoref May 3, 2022

Choose a reason for hiding this comment

jsoref May 3, 2022

Choose a reason for hiding this comment

jsoref May 3, 2022

Choose a reason for hiding this comment

jsoref May 3, 2022

Choose a reason for hiding this comment

timhoffm left a comment

Choose a reason for hiding this comment

timhoffm May 3, 2022

Choose a reason for hiding this comment

greglucas commented May 4, 2022

jsoref commented May 4, 2022

jsoref commented May 4, 2022

jklymak commented May 18, 2022

oscargus commented May 18, 2022

greglucas left a comment

Choose a reason for hiding this comment

jklymak commented May 24, 2022

timhoffm commented May 24, 2022