Skip to content

Conversation

@yarikoptic
Copy link
Contributor

To help keeping DeepLabCut typos free. Individual commits might have more reasoning etc.

I think that numpy.ndarray was intended to me listed as type, and
make variable more explicit to not use typo-close  mot
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@jeylau
Copy link
Contributor

jeylau commented Apr 28, 2023

Hey @yarikoptic, this is cool, thanks a lot! Just one question though: if a typo is detected when the GitHub action runs, does the workflow entirely stop or does codespell auto-fix it? If it doesn't, I'm thinking that maybe we should have a deeplabcut[dev] that installs e.g. codespell, black, pytest.

@jeylau jeylau added the enhancement New feature or request label Apr 28, 2023
@jeylau jeylau self-assigned this Apr 28, 2023
@yarikoptic
Copy link
Contributor Author

yarikoptic commented Apr 28, 2023

Only fails/stops so author could either fix or ignore it. Many projects use pre-commit to automate use of those tools on developer side. Black etc could be added like we have eg in https://github.com/dandi/dandi-cli/blob/master/.pre-commit-config.yaml . But that should be separate/complimentary to this PR IMHO.

@MMathisLab
Copy link
Member

can merge after checks pass, thanks for the contribution @yarikoptic

@MMathisLab MMathisLab merged commit 6ddba79 into DeepLabCut:main May 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants