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

chore: Spelling #3762

Merged
merged 31 commits into from
Apr 17, 2023
Merged

chore: Spelling #3762

merged 31 commits into from
Apr 17, 2023

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Dec 25, 2022

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

What is the previous behavior before this PR?

The misspellings have been reported at jsoref@55adbfb

What is the new behavior after this PR?

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

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.

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Copy link
Contributor 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.

Most corrections automatically suggested by Google Sheets. All fault mine.

- docs: update Gastby logo and link (#2481)
- docs: update Gatsby logo and link (#2481)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a brand.

@@ -1,5 +1,5 @@
/* eslint-disable */
/* -*- Mode: Javascript; indent-tabs-mode:nil; js-indent-level: 2 -*- */
/* -*- Mode: JavaScript; indent-tabs-mode:nil; js-indent-level: 2 -*- */
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Brand

// All surds have 0.08em padding above the viniculum inside the SVG.
// All surds have 0.08em padding above the vinculum inside the SVG.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This item is consistently spelled this way, but the world disagrees...

https://www.merriam-webster.com/dictionary/vinculum

this is a TI(re)L - Google Sheets told me.

src/environments/array.js Show resolved Hide resolved
@ronkok
Copy link
Collaborator

ronkok commented Dec 26, 2022

Good stuff.

@edemaine I think you are the right person to decide if the variable name in macros.js should change from nonexistsOK to nonexistentOK. There might be some small nuance in play there.

All the rest looks good to me.

@edemaine
Copy link
Member

Thanks @ronkok for reviewing! I agree that nonexistsOK would be better, for parallelism with existsOK. What we mean by nonexistsOK is "is it OK that the command doesn't exist?" Another possible spelling would be notExistsOK... is that better/clearer?

@codecov
Copy link

codecov bot commented Dec 26, 2022

Codecov Report

Merging #3762 (e7c2d80) into main (c7b1f84) will not change coverage.
The diff coverage is 94.11%.

❗ Current head e7c2d80 differs from pull request most recent head ae36eab. Consider uploading reports for the commit ae36eab to get more accurate results

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3762   +/-   ##
=======================================
  Coverage   92.98%   92.98%           
=======================================
  Files          91       91           
  Lines        6770     6770           
  Branches     1574     1574           
=======================================
  Hits         6295     6295           
  Misses        437      437           
  Partials       38       38           
Impacted Files Coverage Δ
contrib/render-a11y-string/render-a11y-string.js 83.80% <ø> (ø)
src/Parser.js 96.14% <ø> (ø)
src/buildMathML.js 97.67% <ø> (ø)
src/defineEnvironment.js 100.00% <ø> (ø)
src/environments/array.js 98.04% <ø> (ø)
src/fontMetrics.js 100.00% <ø> (ø)
src/functions/arrow.js 95.83% <ø> (ø)
src/functions/delimsizing.js 97.54% <ø> (ø)
src/mathMLTree.js 86.58% <ø> (ø)
src/parseNode.js 73.33% <ø> (ø)
... and 3 more

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bd502a6...ae36eab. Read the comment docs.

@edemaine
Copy link
Member

P.S. I think adding the "check spelling" action would be cool, as a separate PR, if there aren't any false positives (or there's an easy way to deal with them).

@jsoref
Copy link
Contributor Author

jsoref commented Dec 26, 2022

Oops. Sorry (I failed to properly fill out the description -- fixed...). In regard to adding check-spelling..., you can see the configuration for check-spelling here: jsoref@55adbfb

functionally, https://github.com/jsoref/KaTeX/blob/55adbfb034441663fe62209bd9442cd750a7869b/.github/actions/spelling/expect.txt is a list of terms that check-spelling doesn't naturally recognize (with the addition of supplemental dictionaries) and that I didn't recognize as typos of anything else. You could think of them as "false-positives".

As for dealing w/ false-positives, I've been working on improving the flow. At this point, the current "easiest" approach can be seen in jsoref@55adbfb#commitcomment-94184527

To accept ✔️ these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands

Basically the command will update the metadata and let you commit them. There's also a provision for updating metadata using a PR comment (which my company uses), but I don't have examples of it being generally deployed in public repositories.

I welcome feedback (it does take me some time to digest the feedback and implement a response, and this is a side project, but I try to be fairly responsive).

Copy link
Member

@edemaine edemaine left a comment

Choose a reason for hiding this comment

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

Sorry for the delay on this. Feel free to submit a PR that adds this to the CI workflow; I imagine you'd be the expert on that.

@edemaine edemaine enabled auto-merge (squash) April 17, 2023 18:25
@edemaine edemaine merged commit 62144e4 into KaTeX:main Apr 17, 2023
@KaTeX-bot
Copy link
Member

🎉 This PR is included in version 0.16.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

None yet

4 participants