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

docs: v.to.db.html fix manual typo #4615

Merged
merged 1 commit into from
Oct 29, 2024
Merged

docs: v.to.db.html fix manual typo #4615

merged 1 commit into from
Oct 29, 2024

Conversation

dhdeangelis
Copy link
Contributor

No description provided.

@github-actions github-actions bot added vector Related to vector data processing HTML Related code is in HTML module docs labels Oct 29, 2024
Copy link
Member

@echoix echoix left a comment

Choose a reason for hiding this comment

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

I didn't catch anything else in the file too.

@neteler
Copy link
Member

neteler commented Oct 29, 2024

How about running https://github.com/OSGeo/grass/blob/main/utils/fix_typos.sh on (parts of) the source code? In the past I had good experience with it.

(it is based on https://github.com/codespell-project/codespell)

@echoix
Copy link
Member

echoix commented Oct 29, 2024

There's also cspell, but it is not co figured yet to not trigger to all the proper nouns we use, so maybe a lot of false positives. It will work for typos in words, not errors in syntax. Works well in code and variable names too (knows where to split words for each of the programming languages).

There's also proselint that is suitable for more of text documents (not sure if support on markup works better now), and is more geared towards errors between words, higher level, like consistency, clichés, jargon, cursing, archaisms, sexism, uncomparables, etc.

There's also vale, that is flexible too.

But cspell is kinda the most used, and IDE integrations, especially for VSCode makes it really easy to use.

@echoix
Copy link
Member

echoix commented Oct 29, 2024

Personally, when needing to correct documents, I use the (paid) Antidote tool, the reference spell checking software for decades developed in Québec, that for 10 years has an English module. It also supports filtering out markup, so works now also with Tex, markdown, html. But it's not that useful to use in code.

@echoix echoix merged commit 94034a3 into OSGeo:main Oct 29, 2024
23 checks passed
@github-actions github-actions bot added this to the 8.5.0 milestone Oct 29, 2024
@dhdeangelis
Copy link
Contributor Author

How about running https://github.com/OSGeo/grass/blob/main/utils/fix_typos.sh on (parts of) the source code? In the past I had good experience with it.

(it is based on https://github.com/codespell-project/codespell)

I didn't know about that script but I basically did the same using hunspell. For another project I run spell check on many files, so I got inspired and did the same all GRASS html manual files (many of which contain typos). The result is text file with 'misspellings' for each file, most of them just technical nouns and abbreviations. Then it is a simple (and educative) matter to go one file at a time, identify the misspellings, correct them and submit a PR. Since this takes only a few minutes for one html file it can be done within the course of a normal day without having to set aside special time. I actually find it entertaining.

@dhdeangelis dhdeangelis deleted the manfx branch October 29, 2024 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs HTML Related code is in HTML module vector Related to vector data processing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants