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

Problem: there are spelling errors #257

Closed
eviau-artefactual opened this issue Feb 2, 2024 · 3 comments
Closed

Problem: there are spelling errors #257

eviau-artefactual opened this issue Feb 2, 2024 · 3 comments
Labels
typo Minor typo noticed in the documentation

Comments

@eviau-artefactual
Copy link
Contributor

Hello ✨

I was looking at automated ways to improve the docs.

There is a Sphinx spellchecker: https://sphinxcontrib-spelling.readthedocs.io/

Would we be interested in using it ? I will open a PR setting it up to allow you to look at potential results enabled by this tool.

@eviau-artefactual
Copy link
Contributor Author

Looking at the results, some of them are useful, like this typo: https://github.com/artefactual/atom-docs/actions/runs/7761741254/job/21170791245#step:6:1875

Most of them are technical terms... I am not sure what to do with this for now. If you do decide that this is worthwhile I can make a proper PR and (try to) correct most spelling mistakes, for a given locale.

@eviau-artefactual eviau-artefactual added the typo Minor typo noticed in the documentation label Feb 2, 2024
@melaniekung
Copy link
Contributor

hi edith! i think this would be very useful and would love to see a PR for this! thank you for looking into it!

@eviau-artefactual
Copy link
Contributor Author

The PRs #269 and #265 should have fixed all existing typos in the atom-docs repo.

The PR #263 enables spellchecking for the future.

we can add new words to the spelling_wordlist.txt file as needed.

Thanks everyone ✨

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

No branches or pull requests

2 participants