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

Spelling #474

Open
wants to merge 34 commits into
base: homebrew
Choose a base branch
from
Open

Spelling #474

wants to merge 34 commits into from

Conversation

jsoref
Copy link

@jsoref jsoref commented May 3, 2023

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

The misspellings have been reported at https://github.com/jsoref/scimax/actions/runs/4870186792#summary-13196829839

The action reports that the changes in this PR would make it happy: https://github.com/jsoref/scimax/actions/runs/4870186748#summary-13196830541

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.

This is a follow-up to #451. I've mostly performed a rebase for the fixes, there were only a couple of items that were new.

If you'd like me to drop things in "deprecated" or other paths, please let me know. I'm more than happy to drop things. If at some point you actually like the changes, I'm quite happy to squash the commits together. I do not squash eagerly as I assume that people will find at least some of my changes controversial.

Note that for this, I redid the work to calculate which things to ignore (the engine for check-spelling has improved significantly since the previous PR).

Copy link
Author

@jsoref jsoref left a comment

Choose a reason for hiding this comment

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

One other change between the previous PR and this is that I've finally added a Lisp dictionary to check-spelling...

Anyway, here are some quick highlights

Copy link
Author

Choose a reason for hiding this comment

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

As noted, I'm quite happy to drop all files matching a certain path, e.g. ^deprecated/

5. At the beginning of a delete and end of another mark. Just move in to previous mark. [[(delete-2-end+mark)]].
5. At the beginning of a delete and end of another mark. Just move it to previous mark. [[(delete-2-end+mark)]].
Copy link
Author

Choose a reason for hiding this comment

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

Normally I change in to to into, but here it seemed that this might be intended.

_g_: GitHUB _i_: Instagram
_g_: GitHub _i_: Instagram
Copy link
Author

Choose a reason for hiding this comment

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

This is kind of notable.

Normally I change Github to GitHub, but this is a bit different.

scimax-gitter.el Outdated Show resolved Hide resolved
You can have proper scientific citations like this <sup id="9e3ad98c9008c49c9d14834ca3913eb6"><a href="#kitchin-2015-examp" title="Kitchin, Examples of Effective Data Sharing in Scientific Publishing, {ACS Catalysis}, v(6), 3894-3899 (2015).">kitchin-2015-examp</a></sup>, including multiple references <sup id="66b54b1976758a93506a846c2666419b"><a href="#kitchin-2015-data-surfac-scien" title="John Kitchin, Data Sharing in Surface Science, Surface Science , v(), 103-107 (2016).">kitchin-2015-data-surfac-scien</a></sup><sup>,</sup><sup id="9e3ad98c9008c49c9d14834ca3913eb6"><a href="#kitchin-2015-examp" title="Kitchin, Examples of Effective Data Sharing in Scientific Publishing, {ACS Catalysis}, v(6), 3894-3899 (2015).">kitchin-2015-examp</a></sup><sup>,</sup><sup id="fe4ece7c7b3687ca21f32c0ee4e0a542"><a href="#kitchin-2016-autom-data" title="Kitchin, Van Gulick \&amp; Zilinski, Automating Data Sharing Through Authoring Tools, International Journal on Digital Libraries, v(2), 93--98 (2016).">kitchin-2016-autom-data</a></sup>. Check out the tooltips on them in the html that Github renders. Somewhat unfortunately, the citations are exported basically as html, so they are not fun to read in the markdown. Oh well, did I mention tooltips!
You can have proper scientific citations like this <sup id="9e3ad98c9008c49c9d14834ca3913eb6"><a href="#kitchin-2015-examp" title="Kitchin, Examples of Effective Data Sharing in Scientific Publishing, {ACS Catalysis}, v(6), 3894-3899 (2015).">kitchin-2015-examp</a></sup>, including multiple references <sup id="66b54b1976758a93506a846c2666419b"><a href="#kitchin-2015-data-surfac-scien" title="John Kitchin, Data Sharing in Surface Science, Surface Science , v(), 103-107 (2016).">kitchin-2015-data-surfac-scien</a></sup><sup>,</sup><sup id="9e3ad98c9008c49c9d14834ca3913eb6"><a href="#kitchin-2015-examp" title="Kitchin, Examples of Effective Data Sharing in Scientific Publishing, {ACS Catalysis}, v(6), 3894-3899 (2015).">kitchin-2015-examp</a></sup><sup>,</sup><sup id="fe4ece7c7b3687ca21f32c0ee4e0a542"><a href="#kitchin-2016-autom-data" title="Kitchin, Van Gulick \&amp; Zilinski, Automating Data Sharing Through Authoring Tools, International Journal on Digital Libraries, v(2), 93--98 (2016).">kitchin-2016-autom-data</a></sup>. Check out the tooltips on them in the html that GitHub renders. Somewhat unfortunately, the citations are exported basically as html, so they are not fun to read in the markdown. Oh well, did I mention tooltips!
Copy link
Author

Choose a reason for hiding this comment

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

-Github renders
+GitHub renders

;; http://qaz.wtf/u/convert.cgi?text=ABCDEFGHIJKLMNOPQRSTUVWZYZabcdefghijklmnopqrstuvwxyz0123456789
;; http://qaz.wtf/u/convert.cgi?text=ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789
Copy link
Author

Choose a reason for hiding this comment

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

-VWZYZ
+VWXYZ

scimax-utils.el Outdated
Only works on Mac OSX."
Only works on macOS."
Copy link
Author

Choose a reason for hiding this comment

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

brand (the old brand was Mac OS X, the current brand is macOS)

@jkitchin
Copy link
Owner

jkitchin commented May 3, 2023

I probably should have noted i fixed these on the homebrew branch, and will eventually merge that onto the master branch.

How do you run this spell check?

@jsoref
Copy link
Author

jsoref commented May 3, 2023

Oh!

I apply this commit:
jsoref@21de372
Or more accurately, I apply a series of commits and iterate:
https://github.com/check-spelling/scimax/actions/workflows/spelling.yml

jsoref and others added 27 commits May 3, 2023 10:00
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
jsoref added 7 commits May 3, 2023 10:03
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
@jsoref jsoref changed the base branch from master to homebrew May 3, 2023 14:04
@jsoref
Copy link
Author

jsoref commented May 3, 2023

Ok, I've rebased the commits onto the homebrew branch.
And I pushed a rebased https://github.com/jsoref/scimax/tree/spell-check branch with jsoref@9731f2c
which generated https://github.com/jsoref/scimax/actions/runs/4872848445#summary-13204517578 which is what I'd look at if I were starting again (I'm not doing another run this morning, I need to go into the office and work on my day job things).

If you'd like to use the workflow or have any questions, I should be able to respond tonight or tomorrow night.

Thanks for the prompt feedback and have a great day.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants