datalad / datalad-gooey

A graphical user interface for DataLad (datalad.org)
https://docs.datalad.org/projects/gooey
Other
4 stars 6 forks source link

ENH: add codespell linting (and tox.ini for that) + fix typos it found #279

Closed yarikoptic closed 1 year ago

welcome[bot] commented 1 year ago

Thank You Banner (Image: CC-BY license, The Turing Way Community, & Scriberia. Zenodo. http://doi.org/10.5281/zenodo.3332808) Wohoo! :tada: Thanks for opening your first pull request! :sunglasses: We really appreciate your time and effort to contribute to the project - you're amazing! :clap:

codecov-commenter commented 1 year ago

Codecov Report

Base: 66.22% // Head: 66.22% // No change to project coverage :thumbsup:

Coverage data is based on head (3d9a3d6) compared to base (01cf641). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #279 +/- ## ======================================= Coverage 66.22% 66.22% ======================================= Files 39 39 Lines 2209 2209 ======================================= Hits 1463 1463 Misses 746 746 ``` | [Impacted Files](https://codecov.io/gh/datalad/datalad-gooey/pull/279?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datalad) | Coverage Δ | | |---|---|---| | [datalad\_gooey/\_version.py](https://codecov.io/gh/datalad/datalad-gooey/pull/279/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datalad#diff-ZGF0YWxhZF9nb29leS9fdmVyc2lvbi5weQ==) | `100.00% <ø> (ø)` | | | [datalad\_gooey/api\_utils.py](https://codecov.io/gh/datalad/datalad-gooey/pull/279/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datalad#diff-ZGF0YWxhZF9nb29leS9hcGlfdXRpbHMucHk=) | `92.00% <ø> (ø)` | | | [datalad\_gooey/datalad\_ui.py](https://codecov.io/gh/datalad/datalad-gooey/pull/279/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datalad#diff-ZGF0YWxhZF9nb29leS9kYXRhbGFkX3VpLnB5) | `60.37% <ø> (ø)` | | | [datalad\_gooey/param\_form\_utils.py](https://codecov.io/gh/datalad/datalad-gooey/pull/279/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datalad#diff-ZGF0YWxhZF9nb29leS9wYXJhbV9mb3JtX3V0aWxzLnB5) | `86.73% <ø> (ø)` | | | [datalad\_gooey/param\_widgets.py](https://codecov.io/gh/datalad/datalad-gooey/pull/279/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datalad#diff-ZGF0YWxhZF9nb29leS9wYXJhbV93aWRnZXRzLnB5) | `57.00% <ø> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datalad). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datalad)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

mih commented 1 year ago

Thanks, that would be useful. However, I am concerned that it will trip over any keyboard navigation hint. You already added exceptions manually, but more are needed (and will be needed, already now and in the future).

Is there a way to ignore any words that have &?

yarikoptic commented 1 year ago

Is there a way to ignore any words that have &?

I think I have managed via --ignore-regex! Relevant ref: request for pragma definitions to skip lines: https://github.com/codespell-project/codespell/issues/1212

and your concern is confirmed in current fail here (did not see it locally)

lint run-test: commands[0] | codespell -x .codespell-ignorelines -D- --skip '_version.py,*.pem' datalad_gooey setup.py
datalad_gooey/resources/ui/credentials_dialog.ui:[11](https://github.com/datalad/datalad-gooey/actions/runs/3159329253/jobs/5142427042#step:5:12)1: ecret ==> secret, erect
yarikoptic commented 1 year ago

@mih -- green now, so "handing it off" ;)

welcome[bot] commented 1 year ago

Congratulations Banner (Image: CC-BY license, The Turing Way Community, & Scriberia. Zenodo. http://doi.org/10.5281/zenodo.3332808) Congrats on merging your first pull request! :tada: The DataLad Team appreciates your contribution greatly, and we want to say thanks! :sparkling_heart: Now go ahead and share your first merge with your colleagues, you got yourself this brag right! :smile: :gift: