Conversation
|
Hi @yarikoptic, thanks for this suggestion. We have "Vale" in place too to check spelling for markdown files. Before adding in another tool, I think we should check if there's any overlap and if not make sure they check things in similar ways to keep spelling consistency across python and markdown files. |
| config = {"filepath": "{nam}.csv"} | ||
| config = {"filepath": "{name}.csv"} | ||
| CatalogConfigResolver._validate_pattern_config(pattern, config) | ||
| # DatasetError: Incorrect dataset configuration provided. Keys used in the configuration {'{nam}'} should present in |
There was a problem hiding this comment.
This seems to be an intentional misspelling
There was a problem hiding this comment.
gotcha - fixed
yarikoptic
force-pushed
the
enh-codespell
branch
from
26f4928 to
1c47cc5
Compare
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
=== Do not change lines below ===
{
"chain": [],
"cmd": "sed -i -e 's,\\(fo=conf_source.*\\),\\1 # codespell:ignore,g' ./kedro/config/omegaconf_config.py",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
yarikoptic
force-pushed
the
enh-codespell
branch
from
1c47cc5 to
5ee6525
Compare
|
@merelcht note that codespell does not actually "spell" -- it just fixes typos it knows about. So there should be less false positives. But also it checks all and any text file(s) it finds, so not language/format aware/specific at all. Altogether could be considered complimentary. Your call |
…nteractively
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w -i 3 -C 4 ./tests/framework/project/test_logging.py ./kedro/io/catalog_config_resolver.py",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
…os automagically
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
Overall, Vale is more of a prose style linter, while Codespell is a minimalist spell checker. That said, Vale does have a spell checker, too. But why is it off for Markdown? 🤔 Line 7 in 491c822 The other problem with Vale IMO is that it gives so many suggestions that people just ignore them Looking at the logs on https://github.com/kedro-org/kedro/actions/runs/16328163642/job/46123623172, there are even some ERROR severity things flagged (not introduced by the PR). I think it's fine to use Vale for spelling if it works, but it's worth understanding why it's not flagging some of these obvious issues. |
yarikoptic
force-pushed
the
enh-codespell
branch
from
5ee6525 to
b9a8df5
Compare
|
@deepyaman The spell check is on, it just uses the Kedro config https://github.com/kedro-org/kedro/blob/main/.github/styles/Kedro/Spellings.yml instead of the default Vale one. |
|
We already have Vale as a spell checker for docs, but since we added it, it only ran on the new additions which is why I think some of these typos were left out. I suppose |
|
I agree with @ankatiyar ! Let's include the fixes, but leave |
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
merelcht
changed the title
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
ankatiyar
left a comment
ankatiyar
left a comment
There was a problem hiding this comment.
Thanks @merelcht and @yarikoptic
Signed-off-by: ElenaKhaustova <157851531+ElenaKhaustova@users.noreply.github.com>
5 participants
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.
Note that it fixes
pattensin a signature (and body) of an internal function