Add codespell support (config, workflow to detect/not fix) and make it fix few typos #856
Conversation
=== Do not change lines below ===
{
"chain": [],
"cmd": "git-sedi flourescent fluorescent; git-sedi soure source",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
| @@ -13970,7 +13970,7 @@ slots: | |||
| description: Previous land use and dates | |||
| title: history/previous land use | |||
| examples: | |||
| - value: fallow; 2018-05-11:T14:30Z | |||
| - value: follow; 2018-05-11:T14:30Z | |||
There was a problem hiding this comment.
this is an incorrect conversion the word is meant to be fallow (meaning not sown with seed) not follow.
| @@ -20941,7 +20941,7 @@ classes: | |||
| host_symbiont: | |||
| name: host_symbiont | |||
| examples: | |||
| - value: Paragordius varius | |||
| - value: Paragordius various | |||
There was a problem hiding this comment.
this is an incorrect change, the value should remain as "varius" as its a species name.
| @@ -23983,7 +23983,7 @@ classes: | |||
| host_symbiont: | |||
| name: host_symbiont | |||
| examples: | |||
| - value: Paragordius varius | |||
| - value: Paragordius various | |||
There was a problem hiding this comment.
this is an incorrect change, the value should remain as "varius" as its a species name.
There was a problem hiding this comment.
I dont think we should be adding in additional code to do spell checking on items in the repo without a careful and knowledgable person checking which files it is looking at and how any changes effect the workflow. Additionally due to the scientific nature of the terminology there are a number of cases that a generic change to the commonly expected word is just wrong, e.g. fallow to follow.
More about codespell: https://github.com/codespell-project/codespell .
I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.
CI workflow has 'permissions' set only to 'read' so also should be safe.
It is a lot of changes due to huge amount of duplication. But here is a list of typos fixed and how (I went with the first hit for the two ambiguous)