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 various typos #16

Merged
merged 1 commit into from
Feb 23, 2022
Merged

Fix various typos #16

merged 1 commit into from
Feb 23, 2022

Conversation

luzpaz
Copy link
Contributor

@luzpaz luzpaz commented Feb 22, 2022

Found via codespell -q 3 -L acount,aray,ba,childs,comando,desig,fo,mater,nd,ocur,pard,survice

@brlcad
Copy link
Member

brlcad commented Feb 22, 2022

Hi @luzpaz this looks really impressive, but it can't be applied as-is since you've included modifications to 3rd party codes that are merely co-located in our repository for compilation, and are not ours to modify. Can you exclude all of src/other and misc/tools? That will make this a lot easier to review...

@brlcad
Copy link
Member

brlcad commented Feb 22, 2022

Others to exclude include:
doc/docbook/resources/other/docbook5xi.rnc
misc/ (all of it, not just misc/tools)

Found via `codespell -q 3 -S ./src/other,./misc -L acount,aray,ba,childs,comando,desig,fo,mater,nd,ocur,pard,survice`
Revert `misc/` and docbook changes
@luzpaz
Copy link
Contributor Author

luzpaz commented Feb 22, 2022

@brlcad please recheck

@brlcad brlcad merged commit 43d368f into BRL-CAD:main Feb 23, 2022
@brlcad
Copy link
Member

brlcad commented Feb 23, 2022

@luzpaz This looks great, thank you! I'm half-surprised you found as many as you did. We've had a few devs over the years obsess over spelling. The ones you found may have been introduced in the past couple years. I've credited you in our AUTHORS file as Luz Paz , but let me know if there's another name you'd prefer.

I see from your commit history that you're really good at doing spelling fixes for folks. Have you considered trying to automate it? Either on a case-by-case basis, like helping us create a regression test that detects / prevents new mistakes, or across a set of projects where you scan and submit PRs periodically?

@luzpaz luzpaz deleted the typos branch February 23, 2022 07:10
@luzpaz
Copy link
Contributor Author

luzpaz commented Feb 23, 2022

@brlcad I'm happy to do it. You would be surprised at the amount of bugs that have been solved by doing a deeper spell check. I use a combination of codespell and vscode regex-fu to run these analyses. As for automation, it's pretty simple to set up a GH action. Just 2 files are needed

.github/workflows/codespell.yml
.github/codespellignore

Here's how FreeCAD did it:
FreeCAD/FreeCAD@c7cf9b2

As for automating PRs across several projects, that could be out of my coding scope + codespell does give a number of false positives because it's still a WIP itself. Last thing I want to do is irritate FLOSS devs that are (already) overworked etc...by submitting yet another PR that would not be necessary for them to review. Some devs think spelling for source comments is trivial or that these types of PRs are motivated by an agenda for notoriety. Anyway, like I said, I'm happy to do it as a contribution to FLOSS.

zhuodannychen pushed a commit to zhuodannychen/brlcad that referenced this pull request May 9, 2023
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