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

Fix two typos and add a spellcheck #4034

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

TheGiraffe3
Copy link

Fixes #4033

In this pull request, I added a spellcheck and fixed two typos found by it.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow the [best practices][best_practices].
  • My code follows the established code style of the repository.

I think so; it's not exactly code.

  • I added or updated documentation (if applicable).

The whole pull request is about updating documentation.

  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Copy link
Contributor

@seancolsen seancolsen 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 this, @TheGiraffe3.

I would definitely like to merge the specific spelling corrections in this PR.

And I also love the idea of adding some tooling to catch spelling mistakes!

I don't love the idea of leaning so hard on GitHub actions though, because it's hard to run workflows like this locally, so you don't end up seeing the test failures until its in CI. It's not necessarily a show-stopper, but it would be nice to have something that we could run locally too. Ideally something that integrates with mkdocs so that it throws errors when running build --strict. For example mkdocs-spellcheck
looks promising, though I've not tried it. Looks like we'd be able to configure ignored words directly within mkdocs.yml, which would be convenient. Another approach would be finding a separate python-based markdown linting tool and adding a local script to run it. I wouldn't be surprised if there might even be some tools that perform more elaborate grammar checking. If we could get a local spell-checking solution set up, then we'd still add a GitHub action that runs that script to ensure that PRs with spelling errors fail.

As a side-note: If we could use such a tool to enforce some of our other markdown code standards that would be nice too. I did some research a while back into potentially adopting mdformat to auto-format our markdown. I ran into a snag. I could be worth picking this work back up though.

If you'd be up for taking a stab at getting a docs spell-checker working locally too, then that would be really nice. If not, I can understand. Let me know. This PR definitely adds value as-is so I'm inclined to merge it if you're not up for digger deeper into the local spell-checking use-case.

@seancolsen seancolsen added the pr-status: revision A PR awaiting follow-up work from its author after review label Nov 21, 2024
@TheGiraffe3
Copy link
Author

It's possible to configure ignored words in a separate file, which can be placed anywhere; I just didn't include that here because it wasn't necessary.

I'll look into the possibility of a local spellcheck, though it may take a few days.

@TheGiraffe3 TheGiraffe3 marked this pull request as draft November 21, 2024 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: revision A PR awaiting follow-up work from its author after review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Two typos in the docs folder
2 participants