Add codespell support (config, workflow to detect/not fix) and make it fix few typos #409
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…(but ignoring overall fail due to ambigous ones)
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w || :",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w -i 3 -C 2",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
matentzn
reviewed
Feb 6, 2025
There was a problem hiding this comment.
@yarikoptic Thank you so much for your contribution! This is very valuable.
Just two comments / questions before we merge. Thank you!
Also, I am slightly concerned about having workflows blocking PRs for spelling mistakes but I will sort it out when the time comes.
Awesome!
| @@ -1844,7 +1844,7 @@ | |||
| { | |||
| "name": "similarity_score", | |||
| "definition_uri": "https://w3id.org/sssom/similarity_score", | |||
| "description": "A score between 0 and 1 to denote the similarity between two entities, where 1 denotes equivalence, and 0 denotes disjointness. The score is meant to be used in conjunction with the similarity_measure field, to document, for example, the lexical or semantic match of a matching algorithm.", | |||
| "description": "A score between 0 and 1 to denote the similarity between two entities, where 1 denotes equivalence, and 0 denotes disjointedness. The score is meant to be used in conjunction with the similarity_measure field, to document, for example, the lexical or semantic match of a matching algorithm.", | |||
There was a problem hiding this comment.
disjointness is a technical term in our domain, and should not be replaced.
| @@ -350,7 +350,7 @@ | |||
| "type": "string" | |||
| }, | |||
| "similarity_score": { | |||
| "description": "A score between 0 and 1 to denote the similarity between two entities, where 1 denotes equivalence, and 0 denotes disjointness. The score is meant to be used in conjunction with the similarity_measure field, to document, for example, the lexical or semantic match of a matching algorithm.", | |||
| "description": "A score between 0 and 1 to denote the similarity between two entities, where 1 denotes equivalence, and 0 denotes disjointedness. The score is meant to be used in conjunction with the similarity_measure field, to document, for example, the lexical or semantic match of a matching algorithm.", | |||
| @@ -411,7 +411,7 @@ owl:Axiom a sh:NodeShape ; | |||
| sh:order 28 ; | |||
| sh:path pav:authoredOn ], | |||
| [ sh:datatype xsd:double ; | |||
| sh:description "A score between 0 and 1 to denote the similarity between two entities, where 1 denotes equivalence, and 0 denotes disjointness. The score is meant to be used in conjunction with the similarity_measure field, to document, for example, the lexical or semantic match of a matching algorithm." ; | |||
| sh:description "A score between 0 and 1 to denote the similarity between two entities, where 1 denotes equivalence, and 0 denotes disjointedness. The score is meant to be used in conjunction with the similarity_measure field, to document, for example, the lexical or semantic match of a matching algorithm." ; | |||
| @@ -46,7 +46,7 @@ | |||
| -- * Slot: mapping_date Description: The date the mapping was asserted. This is different from the date the mapping was published or compiled in a SSSOM file. | |||
| -- * Slot: publication_date Description: The date the mapping was published. This is different from the date the mapping was asserted. | |||
| -- * Slot: confidence Description: A score between 0 and 1 to denote the confidence or probability that the match is correct, where 1 denotes total confidence. | |||
| -- * Slot: similarity_score Description: A score between 0 and 1 to denote the similarity between two entities, where 1 denotes equivalence, and 0 denotes disjointness. The score is meant to be used in conjunction with the similarity_measure field, to document, for example, the lexical or semantic match of a matching algorithm. | |||
| # Ref: https://github.com/codespell-project/codespell#using-a-config-file | ||
| skip = '.git*,*.pdf,*.lock' | ||
| check-hidden = true | ||
| ignore-regex = '\b(COMENT|EHR|LOD)\b' |
There was a problem hiding this comment.
is this where to add exceptions?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.