Enable spell checker#10898
Conversation
DelazJ
added
backport release_3.44
| [": menuselection: "]=":menuselection:" | ||
| [":menuselection : "]=":menuselection:" | ||
| [": menuselection :"]=":menuselection:" | ||
| #specific context |
There was a problem hiding this comment.
I think in general this file is misused and we should only apply these kind of substitutions in select cases, not as a form of on the fly spell checker. If we run the spell checker across the sources and fix the issues there they should not come back with the pre-commit check in place and we don't end up having misspelled text in the source and potentially indexed, shared for translations, incurring maintenance overhead to keep this file current etc.
There was a problem hiding this comment.
Thanks @timlinux for the reviews
I think in general this file is misused and we should only apply these kind of substitutions in select cases, not as a form of on the fly spell checker.
Fully agreed. These changes are just a place I store the fixes in the meantime ( in the case I have issues with backporting to 3.44, or there were other occurrences in that branch). Expected to revert these changes after.
Still, the script in its default state, also handles misspells in the locale folder, for Sphinx roles in translation, ensuring a better generated docs display. I am not sure there is anything else doing that.
| - id: codespell | ||
| args: | ||
| - --skip=*.po,*.pot,*.mo,*.svg,*.png,*.jpg,*.gif,*.ico,*.pyc,*.js,*.css,*.map,*.qgs,*.qgz | ||
| - --ignore-words-list=tripel,linz,parameteras,lightening,clos,januar,claus,sist,pixelx |
There was a problem hiding this comment.
Is this list correct and intended? Most of them look like true errors.
There was a problem hiding this comment.
Almost, there are:
- names: Tripel (from Winkel Triple projection), Claus (for Santa Claus), Linz and Sist are services, Januar and Clos are contributors
- methods: parameterAs
- arguments: pixelX. Weirdly mapX and pixelY look correct...
Yes, the checker is case-insensitive.
My only reservation was lightening but it seems correct and anyway would have to be fixed in code repo given that we pull their text here.
fixing list of words and file formats (project file) to ignore
DelazJ
removed
the
backport release_3.44
2 participants
Another subset of pre-commit hooks from #10856, focusing on spelling checks
Goal:
Ticket(s): #