DOC codespell fixes #26422
DOC codespell fixes #26422
Conversation
I tried my best to mimic ad-hoc yaml formatting in the rest of the file
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
doc/whats_new/v1.3.rst
Outdated
| - |Fix| :func:`metric.ndcg_score` now gives a meaningful error message for input of | ||
| length 1. | ||
| :pr:`25672` by :user:`Lene Preuss <lene>` and :user:`Wei-Chun Chu <wcchu>`. | ||
| :pr:`25672` by :user:`Lene Preuss <lens>` and :user:`Wei-Chun Chu <wcchu>`. |
There was a problem hiding this comment.
This one should not be changed this is a github user handle. Not sure what option there is to tell codespell to leave this one alone (and maybe similar ones like <some-text-here-for-a-github-handle> in particular in whats_new rst files).
|
@yarikoptic Could you push on your fork instead of the main repository? |
glemaitre
left a comment
glemaitre
left a comment
There was a problem hiding this comment.
In the previous iteration, we did not question whether to integrate or not codespell. It seems that there is only a single false positive.
I would still be +1 going towards having a pre-commit and GitHub action.
|
At the last iteration we didn't want to integrate it with CI / pre-commits partially because of the issue @lesteve brings up. Also, @yarikoptic please never create branches on the main repo, always use forks, please set your git remote of I'm fine with the changes that this detects, but I'm -0 on adding it to CI if we can't ignore a word from a single file instead of a global ignore. |
adrinjalali
left a comment
adrinjalali
left a comment
There was a problem hiding this comment.
I removed the action and the pre-commit hook form here, this is now an easy merge. Merging, we can discuss adding the actions in a different thread.
adrinjalali
changed the title
Co-authored-by: adrinjalali <[email protected]>
Co-authored-by: adrinjalali <[email protected]>
What does this implement/fix? Explain your changes.
codespell config was provided awhile ago but no machinery was actually deployed to ensure that anyone would use it and keep code free of typos. With this PR codebase would be protected at pre-commit and CI levels from typos to enter the code base.