-
Notifications
You must be signed in to change notification settings - Fork 472
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README.rst #2466
Update README.rst #2466
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some potential enhancements.
As I often have trouble understanding the ignore list and explaining it to new users, I hope this change can get merged soon to help clarify. @peternewman and @andyholmes |
|
a63e622
to
9b29c70
Compare
bb09cb3
to
299d30c
Compare
Update the README to elaborate on case-sensitivity in ignored words and dictionaries. Add an additional "Ignoring Words" section, with internal link from the "noteworthy flags" overview. Co-authored-by: Peter Newman <[email protected]> Co-authored-by: Dimitri Papadopoulos Orfanos <[email protected]>
299d30c
to
d2d3f78
Compare
@peternewman I think all requested changes have been applied.
@andyholmes and @larsoner could you have a look before merging? |
LGTM |
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [codespell-project/codespell](https://togithub.com/codespell-project/codespell) | repository | patch | `v2.2.4` -> `v2.2.5` | Note: The `pre-commit` manager in Renovate is not supported by the `pre-commit` maintainers or community. Please do not report any problems there, instead [create a Discussion in the Renovate repository](https://togithub.com/renovatebot/renovate/discussions/new) if you have any questions. --- ### Release Notes <details> <summary>codespell-project/codespell</summary> ### [`v2.2.5`](https://togithub.com/codespell-project/codespell/releases/tag/v2.2.5) [Compare Source](https://togithub.com/codespell-project/codespell/compare/v2.2.4...v2.2.5) #### What's Changed - Add fixing consciousely typo by [@​yarikoptic](https://togithub.com/yarikoptic) in [https://github.com/codespell-project/codespell/pull/2777](https://togithub.com/codespell-project/codespell/pull/2777) - atalog typo (saw twice in a project) by [@​yarikoptic](https://togithub.com/yarikoptic) in [https://github.com/codespell-project/codespell/pull/2782](https://togithub.com/codespell-project/codespell/pull/2782) - created fstrings by [@​marksmayo](https://togithub.com/marksmayo) in [https://github.com/codespell-project/codespell/pull/2784](https://togithub.com/codespell-project/codespell/pull/2784) - Replace bandit, isort, pylint, pyupgrade, and flake8 plus plugins with ruff by [@​cclauss](https://togithub.com/cclauss) in [https://github.com/codespell-project/codespell/pull/2779](https://togithub.com/codespell-project/codespell/pull/2779) - Add Microsoft Mispelling by [@​Casey-Kiewit](https://togithub.com/Casey-Kiewit) in [https://github.com/codespell-project/codespell/pull/2789](https://togithub.com/codespell-project/codespell/pull/2789) - Use Latest Version In README Pre-Commit Example by [@​Casey-Kiewit](https://togithub.com/Casey-Kiewit) in [https://github.com/codespell-project/codespell/pull/2788](https://togithub.com/codespell-project/codespell/pull/2788) - ruff: Use format specifiers instead of percent format by [@​cclauss](https://togithub.com/cclauss) in [https://github.com/codespell-project/codespell/pull/2787](https://togithub.com/codespell-project/codespell/pull/2787) - New typos by [@​gforcada](https://togithub.com/gforcada) in [https://github.com/codespell-project/codespell/pull/2793](https://togithub.com/codespell-project/codespell/pull/2793) - Ruff: Ignore new rule PLC1901 by [@​cclauss](https://togithub.com/cclauss) in [https://github.com/codespell-project/codespell/pull/2797](https://togithub.com/codespell-project/codespell/pull/2797) - Add various typo fixes by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2795](https://togithub.com/codespell-project/codespell/pull/2795) - Another suggestion by [@​gforcada](https://togithub.com/gforcada) in [https://github.com/codespell-project/codespell/pull/2798](https://togithub.com/codespell-project/codespell/pull/2798) - Fix AssertionError when opening with chardet by [@​n-thumann](https://togithub.com/n-thumann) in [https://github.com/codespell-project/codespell/pull/2785](https://togithub.com/codespell-project/codespell/pull/2785) - Fix typo (and variants) from xxHash by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2761](https://togithub.com/codespell-project/codespell/pull/2761) - Add `huld`->`hold` Spelling Mistake by [@​Casey-Kiewit](https://togithub.com/Casey-Kiewit) in [https://github.com/codespell-project/codespell/pull/2792](https://togithub.com/codespell-project/codespell/pull/2792) - Fix CI issues by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2796](https://togithub.com/codespell-project/codespell/pull/2796) - CI: fix new ruff error B028 by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2802](https://togithub.com/codespell-project/codespell/pull/2802) - Skip subdirectories of hidden directories by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2541](https://togithub.com/codespell-project/codespell/pull/2541) - Add tweek(s)->tweak(s) correction by [@​cfi-gb](https://togithub.com/cfi-gb) in [https://github.com/codespell-project/codespell/pull/2804](https://togithub.com/codespell-project/codespell/pull/2804) - Add supoort->support by [@​thughes](https://togithub.com/thughes) in [https://github.com/codespell-project/codespell/pull/2806](https://togithub.com/codespell-project/codespell/pull/2806) - Add Suggestion For `readded` Mispelling by [@​Casey-Kiewit](https://togithub.com/Casey-Kiewit) in [https://github.com/codespell-project/codespell/pull/2805](https://togithub.com/codespell-project/codespell/pull/2805) - Add displaing->displaying by [@​peternewman](https://togithub.com/peternewman) in [https://github.com/codespell-project/codespell/pull/2808](https://togithub.com/codespell-project/codespell/pull/2808) - Another suggestion for stati by [@​gforcada](https://togithub.com/gforcada) in [https://github.com/codespell-project/codespell/pull/2810](https://togithub.com/codespell-project/codespell/pull/2810) - Add dimaond -> diamond by [@​Moiman](https://togithub.com/Moiman) in [https://github.com/codespell-project/codespell/pull/2813](https://togithub.com/codespell-project/codespell/pull/2813) - Add vai->via, vie by [@​peternewman](https://togithub.com/peternewman) in [https://github.com/codespell-project/codespell/pull/2815](https://togithub.com/codespell-project/codespell/pull/2815) - Remove invalid correction - Kwanza = currency of Angola by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2803](https://togithub.com/codespell-project/codespell/pull/2803) - sinoid and friends by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2807](https://togithub.com/codespell-project/codespell/pull/2807) - Add excludle->exclude by [@​peternewman](https://togithub.com/peternewman) in [https://github.com/codespell-project/codespell/pull/2814](https://togithub.com/codespell-project/codespell/pull/2814) - Add gadjet->gadget and friend by [@​peternewman](https://togithub.com/peternewman) in [https://github.com/codespell-project/codespell/pull/2818](https://togithub.com/codespell-project/codespell/pull/2818) - Add togueter->together by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2821](https://togithub.com/codespell-project/codespell/pull/2821) - Add "mutabl->mutable" by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2822](https://togithub.com/codespell-project/codespell/pull/2822) - Add containin->containing by [@​janosh](https://togithub.com/janosh) in [https://github.com/codespell-project/codespell/pull/2824](https://togithub.com/codespell-project/codespell/pull/2824) - Add mandess->madness by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2825](https://togithub.com/codespell-project/codespell/pull/2825) - some fixes by [@​marksmayo](https://togithub.com/marksmayo) in [https://github.com/codespell-project/codespell/pull/2820](https://togithub.com/codespell-project/codespell/pull/2820) - Fix new ruff errors reported by CI by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2834](https://togithub.com/codespell-project/codespell/pull/2834) - Add fusipn->fusion by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2836](https://togithub.com/codespell-project/codespell/pull/2836) - Add 'subcription->subscription' by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2832](https://togithub.com/codespell-project/codespell/pull/2832) - Add 'promtp->prompt' by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2833](https://togithub.com/codespell-project/codespell/pull/2833) - Add 'endpdoint' as a misspelling of 'endpoint' by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2830](https://togithub.com/codespell-project/codespell/pull/2830) - Add more misspellings of 'identities' by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2829](https://togithub.com/codespell-project/codespell/pull/2829) - Friends of existing typos by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2837](https://togithub.com/codespell-project/codespell/pull/2837) - Fix [`66ec667`](https://togithub.com/codespell-project/codespell/commit/66ec667) by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2838](https://togithub.com/codespell-project/codespell/pull/2838) - equivallent and friends by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2827](https://togithub.com/codespell-project/codespell/pull/2827) - Add delpoys->deploys by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2842](https://togithub.com/codespell-project/codespell/pull/2842) - Added variations on 'difference' by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2841](https://togithub.com/codespell-project/codespell/pull/2841) - Add 'canoncical->canonical' by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2831](https://togithub.com/codespell-project/codespell/pull/2831) - Add additional typos by [@​kianmeng](https://togithub.com/kianmeng) in [https://github.com/codespell-project/codespell/pull/2835](https://togithub.com/codespell-project/codespell/pull/2835) - Add spelling corrections for inject and variants. by [@​cfi-gb](https://togithub.com/cfi-gb) in [https://github.com/codespell-project/codespell/pull/2846](https://togithub.com/codespell-project/codespell/pull/2846) - Add 'credentail->credential' by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2844](https://togithub.com/codespell-project/codespell/pull/2844) - Add 'requestor->requester' by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2845](https://togithub.com/codespell-project/codespell/pull/2845) - Update README.rst by [@​andyholmes](https://togithub.com/andyholmes) in [https://github.com/codespell-project/codespell/pull/2466](https://togithub.com/codespell-project/codespell/pull/2466) - Add exrension(s)->extension(s) by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2847](https://togithub.com/codespell-project/codespell/pull/2847) - Add facttory->factory and facttories-> factories by [@​nils-van-zuijlen](https://togithub.com/nils-van-zuijlen) in [https://github.com/codespell-project/codespell/pull/2848](https://togithub.com/codespell-project/codespell/pull/2848) - Add several spelling corrections by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2849](https://togithub.com/codespell-project/codespell/pull/2849) - Add comtaining->containing by [@​nils-van-zuijlen](https://togithub.com/nils-van-zuijlen) in [https://github.com/codespell-project/codespell/pull/2855](https://togithub.com/codespell-project/codespell/pull/2855) - topoplogical and friends by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2854](https://togithub.com/codespell-project/codespell/pull/2854) - Add placehoulder->placeholder by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2856](https://togithub.com/codespell-project/codespell/pull/2856) - More typos from GlobalProtect-openconnect by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2850](https://togithub.com/codespell-project/codespell/pull/2850) - Add spelling correction for siver->silver/sliver/diver by [@​cfi-gb](https://togithub.com/cfi-gb) in [https://github.com/codespell-project/codespell/pull/2858](https://togithub.com/codespell-project/codespell/pull/2858) - Add assertino->assertion by [@​sourcefrog](https://togithub.com/sourcefrog) in [https://github.com/codespell-project/codespell/pull/2859](https://togithub.com/codespell-project/codespell/pull/2859) - add notority->notoriety by [@​EdwardBetts](https://togithub.com/EdwardBetts) in [https://github.com/codespell-project/codespell/pull/2861](https://togithub.com/codespell-project/codespell/pull/2861) - Misspellings from eLabFTW by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2863](https://togithub.com/codespell-project/codespell/pull/2863) - Add `invirant{,s}->invariant{,s}` by [@​ojeda](https://togithub.com/ojeda) in [https://github.com/codespell-project/codespell/pull/2870](https://togithub.com/codespell-project/codespell/pull/2870) - Add `alloccat*->allocat*` by [@​ojeda](https://togithub.com/ojeda) in [https://github.com/codespell-project/codespell/pull/2869](https://togithub.com/codespell-project/codespell/pull/2869) - Add "multiply"/"multiplies" variations to instances of "multiple" by [@​jdufresne](https://togithub.com/jdufresne) in [https://github.com/codespell-project/codespell/pull/2872](https://togithub.com/codespell-project/codespell/pull/2872) - Add strin->string and optiona->optional by [@​peternewman](https://togithub.com/peternewman) in [https://github.com/codespell-project/codespell/pull/2817](https://togithub.com/codespell-project/codespell/pull/2817) - Add wellplate -> well plate by [@​claydugo](https://togithub.com/claydugo) in [https://github.com/codespell-project/codespell/pull/2873](https://togithub.com/codespell-project/codespell/pull/2873) - Add `afile` Misspelling by [@​Casey-Kiewit](https://togithub.com/Casey-Kiewit) in [https://github.com/codespell-project/codespell/pull/2876](https://togithub.com/codespell-project/codespell/pull/2876) - Ignore 'misspellings' due to string escapes by [@​Zac-HD](https://togithub.com/Zac-HD) in [https://github.com/codespell-project/codespell/pull/2875](https://togithub.com/codespell-project/codespell/pull/2875) - Add `pre-poulate` Misspellings by [@​Casey-Kiewit](https://togithub.com/Casey-Kiewit) in [https://github.com/codespell-project/codespell/pull/2878](https://togithub.com/codespell-project/codespell/pull/2878) #### New Contributors - [@​marksmayo](https://togithub.com/marksmayo) made their first contribution in [https://github.com/codespell-project/codespell/pull/2784](https://togithub.com/codespell-project/codespell/pull/2784) - [@​Casey-Kiewit](https://togithub.com/Casey-Kiewit) made their first contribution in [https://github.com/codespell-project/codespell/pull/2789](https://togithub.com/codespell-project/codespell/pull/2789) - [@​gforcada](https://togithub.com/gforcada) made their first contribution in [https://github.com/codespell-project/codespell/pull/2793](https://togithub.com/codespell-project/codespell/pull/2793) - [@​n-thumann](https://togithub.com/n-thumann) made their first contribution in [https://github.com/codespell-project/codespell/pull/2785](https://togithub.com/codespell-project/codespell/pull/2785) - [@​Moiman](https://togithub.com/Moiman) made their first contribution in [https://github.com/codespell-project/codespell/pull/2813](https://togithub.com/codespell-project/codespell/pull/2813) - [@​sirosen](https://togithub.com/sirosen) made their first contribution in [https://github.com/codespell-project/codespell/pull/2822](https://togithub.com/codespell-project/codespell/pull/2822) - [@​andyholmes](https://togithub.com/andyholmes) made their first contribution in [https://github.com/codespell-project/codespell/pull/2466](https://togithub.com/codespell-project/codespell/pull/2466) - [@​nils-van-zuijlen](https://togithub.com/nils-van-zuijlen) made their first contribution in [https://github.com/codespell-project/codespell/pull/2848](https://togithub.com/codespell-project/codespell/pull/2848) - [@​sourcefrog](https://togithub.com/sourcefrog) made their first contribution in [https://github.com/codespell-project/codespell/pull/2859](https://togithub.com/codespell-project/codespell/pull/2859) - [@​ojeda](https://togithub.com/ojeda) made their first contribution in [https://github.com/codespell-project/codespell/pull/2870](https://togithub.com/codespell-project/codespell/pull/2870) - [@​claydugo](https://togithub.com/claydugo) made their first contribution in [https://github.com/codespell-project/codespell/pull/2873](https://togithub.com/codespell-project/codespell/pull/2873) - [@​Zac-HD](https://togithub.com/Zac-HD) made their first contribution in [https://github.com/codespell-project/codespell/pull/2875](https://togithub.com/codespell-project/codespell/pull/2875) **Full Changelog**: codespell-project/codespell@v2.2.4...v2.2.5 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/allenporter/pyrainbird). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xMTcuMyIsInVwZGF0ZWRJblZlciI6IjM1LjExNy4zIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [codespell-project/codespell](https://togithub.com/codespell-project/codespell) | repository | patch | `v2.2.4` -> `v2.2.5` | Note: The `pre-commit` manager in Renovate is not supported by the `pre-commit` maintainers or community. Please do not report any problems there, instead [create a Discussion in the Renovate repository](https://togithub.com/renovatebot/renovate/discussions/new) if you have any questions. --- ### Release Notes <details> <summary>codespell-project/codespell</summary> ### [`v2.2.5`](https://togithub.com/codespell-project/codespell/releases/tag/v2.2.5) [Compare Source](https://togithub.com/codespell-project/codespell/compare/v2.2.4...v2.2.5) #### What's Changed - Add fixing consciousely typo by [@​yarikoptic](https://togithub.com/yarikoptic) in [https://github.com/codespell-project/codespell/pull/2777](https://togithub.com/codespell-project/codespell/pull/2777) - atalog typo (saw twice in a project) by [@​yarikoptic](https://togithub.com/yarikoptic) in [https://github.com/codespell-project/codespell/pull/2782](https://togithub.com/codespell-project/codespell/pull/2782) - created fstrings by [@​marksmayo](https://togithub.com/marksmayo) in [https://github.com/codespell-project/codespell/pull/2784](https://togithub.com/codespell-project/codespell/pull/2784) - Replace bandit, isort, pylint, pyupgrade, and flake8 plus plugins with ruff by [@​cclauss](https://togithub.com/cclauss) in [https://github.com/codespell-project/codespell/pull/2779](https://togithub.com/codespell-project/codespell/pull/2779) - Add Microsoft Mispelling by [@​Casey-Kiewit](https://togithub.com/Casey-Kiewit) in [https://github.com/codespell-project/codespell/pull/2789](https://togithub.com/codespell-project/codespell/pull/2789) - Use Latest Version In README Pre-Commit Example by [@​Casey-Kiewit](https://togithub.com/Casey-Kiewit) in [https://github.com/codespell-project/codespell/pull/2788](https://togithub.com/codespell-project/codespell/pull/2788) - ruff: Use format specifiers instead of percent format by [@​cclauss](https://togithub.com/cclauss) in [https://github.com/codespell-project/codespell/pull/2787](https://togithub.com/codespell-project/codespell/pull/2787) - New typos by [@​gforcada](https://togithub.com/gforcada) in [https://github.com/codespell-project/codespell/pull/2793](https://togithub.com/codespell-project/codespell/pull/2793) - Ruff: Ignore new rule PLC1901 by [@​cclauss](https://togithub.com/cclauss) in [https://github.com/codespell-project/codespell/pull/2797](https://togithub.com/codespell-project/codespell/pull/2797) - Add various typo fixes by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2795](https://togithub.com/codespell-project/codespell/pull/2795) - Another suggestion by [@​gforcada](https://togithub.com/gforcada) in [https://github.com/codespell-project/codespell/pull/2798](https://togithub.com/codespell-project/codespell/pull/2798) - Fix AssertionError when opening with chardet by [@​n-thumann](https://togithub.com/n-thumann) in [https://github.com/codespell-project/codespell/pull/2785](https://togithub.com/codespell-project/codespell/pull/2785) - Fix typo (and variants) from xxHash by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2761](https://togithub.com/codespell-project/codespell/pull/2761) - Add `huld`->`hold` Spelling Mistake by [@​Casey-Kiewit](https://togithub.com/Casey-Kiewit) in [https://github.com/codespell-project/codespell/pull/2792](https://togithub.com/codespell-project/codespell/pull/2792) - Fix CI issues by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2796](https://togithub.com/codespell-project/codespell/pull/2796) - CI: fix new ruff error B028 by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2802](https://togithub.com/codespell-project/codespell/pull/2802) - Skip subdirectories of hidden directories by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2541](https://togithub.com/codespell-project/codespell/pull/2541) - Add tweek(s)->tweak(s) correction by [@​cfi-gb](https://togithub.com/cfi-gb) in [https://github.com/codespell-project/codespell/pull/2804](https://togithub.com/codespell-project/codespell/pull/2804) - Add supoort->support by [@​thughes](https://togithub.com/thughes) in [https://github.com/codespell-project/codespell/pull/2806](https://togithub.com/codespell-project/codespell/pull/2806) - Add Suggestion For `readded` Mispelling by [@​Casey-Kiewit](https://togithub.com/Casey-Kiewit) in [https://github.com/codespell-project/codespell/pull/2805](https://togithub.com/codespell-project/codespell/pull/2805) - Add displaing->displaying by [@​peternewman](https://togithub.com/peternewman) in [https://github.com/codespell-project/codespell/pull/2808](https://togithub.com/codespell-project/codespell/pull/2808) - Another suggestion for stati by [@​gforcada](https://togithub.com/gforcada) in [https://github.com/codespell-project/codespell/pull/2810](https://togithub.com/codespell-project/codespell/pull/2810) - Add dimaond -> diamond by [@​Moiman](https://togithub.com/Moiman) in [https://github.com/codespell-project/codespell/pull/2813](https://togithub.com/codespell-project/codespell/pull/2813) - Add vai->via, vie by [@​peternewman](https://togithub.com/peternewman) in [https://github.com/codespell-project/codespell/pull/2815](https://togithub.com/codespell-project/codespell/pull/2815) - Remove invalid correction - Kwanza = currency of Angola by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2803](https://togithub.com/codespell-project/codespell/pull/2803) - sinoid and friends by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2807](https://togithub.com/codespell-project/codespell/pull/2807) - Add excludle->exclude by [@​peternewman](https://togithub.com/peternewman) in [https://github.com/codespell-project/codespell/pull/2814](https://togithub.com/codespell-project/codespell/pull/2814) - Add gadjet->gadget and friend by [@​peternewman](https://togithub.com/peternewman) in [https://github.com/codespell-project/codespell/pull/2818](https://togithub.com/codespell-project/codespell/pull/2818) - Add togueter->together by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2821](https://togithub.com/codespell-project/codespell/pull/2821) - Add "mutabl->mutable" by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2822](https://togithub.com/codespell-project/codespell/pull/2822) - Add containin->containing by [@​janosh](https://togithub.com/janosh) in [https://github.com/codespell-project/codespell/pull/2824](https://togithub.com/codespell-project/codespell/pull/2824) - Add mandess->madness by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2825](https://togithub.com/codespell-project/codespell/pull/2825) - some fixes by [@​marksmayo](https://togithub.com/marksmayo) in [https://github.com/codespell-project/codespell/pull/2820](https://togithub.com/codespell-project/codespell/pull/2820) - Fix new ruff errors reported by CI by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2834](https://togithub.com/codespell-project/codespell/pull/2834) - Add fusipn->fusion by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2836](https://togithub.com/codespell-project/codespell/pull/2836) - Add 'subcription->subscription' by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2832](https://togithub.com/codespell-project/codespell/pull/2832) - Add 'promtp->prompt' by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2833](https://togithub.com/codespell-project/codespell/pull/2833) - Add 'endpdoint' as a misspelling of 'endpoint' by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2830](https://togithub.com/codespell-project/codespell/pull/2830) - Add more misspellings of 'identities' by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2829](https://togithub.com/codespell-project/codespell/pull/2829) - Friends of existing typos by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2837](https://togithub.com/codespell-project/codespell/pull/2837) - Fix [`66ec667`](https://togithub.com/codespell-project/codespell/commit/66ec667) by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2838](https://togithub.com/codespell-project/codespell/pull/2838) - equivallent and friends by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2827](https://togithub.com/codespell-project/codespell/pull/2827) - Add delpoys->deploys by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2842](https://togithub.com/codespell-project/codespell/pull/2842) - Added variations on 'difference' by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2841](https://togithub.com/codespell-project/codespell/pull/2841) - Add 'canoncical->canonical' by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2831](https://togithub.com/codespell-project/codespell/pull/2831) - Add additional typos by [@​kianmeng](https://togithub.com/kianmeng) in [https://github.com/codespell-project/codespell/pull/2835](https://togithub.com/codespell-project/codespell/pull/2835) - Add spelling corrections for inject and variants. by [@​cfi-gb](https://togithub.com/cfi-gb) in [https://github.com/codespell-project/codespell/pull/2846](https://togithub.com/codespell-project/codespell/pull/2846) - Add 'credentail->credential' by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2844](https://togithub.com/codespell-project/codespell/pull/2844) - Add 'requestor->requester' by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2845](https://togithub.com/codespell-project/codespell/pull/2845) - Update README.rst by [@​andyholmes](https://togithub.com/andyholmes) in [https://github.com/codespell-project/codespell/pull/2466](https://togithub.com/codespell-project/codespell/pull/2466) - Add exrension(s)->extension(s) by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2847](https://togithub.com/codespell-project/codespell/pull/2847) - Add facttory->factory and facttories-> factories by [@​nils-van-zuijlen](https://togithub.com/nils-van-zuijlen) in [https://github.com/codespell-project/codespell/pull/2848](https://togithub.com/codespell-project/codespell/pull/2848) - Add several spelling corrections by [@​luzpaz](https://togithub.com/luzpaz) in [https://github.com/codespell-project/codespell/pull/2849](https://togithub.com/codespell-project/codespell/pull/2849) - Add comtaining->containing by [@​nils-van-zuijlen](https://togithub.com/nils-van-zuijlen) in [https://github.com/codespell-project/codespell/pull/2855](https://togithub.com/codespell-project/codespell/pull/2855) - topoplogical and friends by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2854](https://togithub.com/codespell-project/codespell/pull/2854) - Add placehoulder->placeholder by [@​sirosen](https://togithub.com/sirosen) in [https://github.com/codespell-project/codespell/pull/2856](https://togithub.com/codespell-project/codespell/pull/2856) - More typos from GlobalProtect-openconnect by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2850](https://togithub.com/codespell-project/codespell/pull/2850) - Add spelling correction for siver->silver/sliver/diver by [@​cfi-gb](https://togithub.com/cfi-gb) in [https://github.com/codespell-project/codespell/pull/2858](https://togithub.com/codespell-project/codespell/pull/2858) - Add assertino->assertion by [@​sourcefrog](https://togithub.com/sourcefrog) in [https://github.com/codespell-project/codespell/pull/2859](https://togithub.com/codespell-project/codespell/pull/2859) - add notority->notoriety by [@​EdwardBetts](https://togithub.com/EdwardBetts) in [https://github.com/codespell-project/codespell/pull/2861](https://togithub.com/codespell-project/codespell/pull/2861) - Misspellings from eLabFTW by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/codespell-project/codespell/pull/2863](https://togithub.com/codespell-project/codespell/pull/2863) - Add `invirant{,s}->invariant{,s}` by [@​ojeda](https://togithub.com/ojeda) in [https://github.com/codespell-project/codespell/pull/2870](https://togithub.com/codespell-project/codespell/pull/2870) - Add `alloccat*->allocat*` by [@​ojeda](https://togithub.com/ojeda) in [https://github.com/codespell-project/codespell/pull/2869](https://togithub.com/codespell-project/codespell/pull/2869) - Add "multiply"/"multiplies" variations to instances of "multiple" by [@​jdufresne](https://togithub.com/jdufresne) in [https://github.com/codespell-project/codespell/pull/2872](https://togithub.com/codespell-project/codespell/pull/2872) - Add strin->string and optiona->optional by [@​peternewman](https://togithub.com/peternewman) in [https://github.com/codespell-project/codespell/pull/2817](https://togithub.com/codespell-project/codespell/pull/2817) - Add wellplate -> well plate by [@​claydugo](https://togithub.com/claydugo) in [https://github.com/codespell-project/codespell/pull/2873](https://togithub.com/codespell-project/codespell/pull/2873) - Add `afile` Misspelling by [@​Casey-Kiewit](https://togithub.com/Casey-Kiewit) in [https://github.com/codespell-project/codespell/pull/2876](https://togithub.com/codespell-project/codespell/pull/2876) - Ignore 'misspellings' due to string escapes by [@​Zac-HD](https://togithub.com/Zac-HD) in [https://github.com/codespell-project/codespell/pull/2875](https://togithub.com/codespell-project/codespell/pull/2875) - Add `pre-poulate` Misspellings by [@​Casey-Kiewit](https://togithub.com/Casey-Kiewit) in [https://github.com/codespell-project/codespell/pull/2878](https://togithub.com/codespell-project/codespell/pull/2878) #### New Contributors - [@​marksmayo](https://togithub.com/marksmayo) made their first contribution in [https://github.com/codespell-project/codespell/pull/2784](https://togithub.com/codespell-project/codespell/pull/2784) - [@​Casey-Kiewit](https://togithub.com/Casey-Kiewit) made their first contribution in [https://github.com/codespell-project/codespell/pull/2789](https://togithub.com/codespell-project/codespell/pull/2789) - [@​gforcada](https://togithub.com/gforcada) made their first contribution in [https://github.com/codespell-project/codespell/pull/2793](https://togithub.com/codespell-project/codespell/pull/2793) - [@​n-thumann](https://togithub.com/n-thumann) made their first contribution in [https://github.com/codespell-project/codespell/pull/2785](https://togithub.com/codespell-project/codespell/pull/2785) - [@​Moiman](https://togithub.com/Moiman) made their first contribution in [https://github.com/codespell-project/codespell/pull/2813](https://togithub.com/codespell-project/codespell/pull/2813) - [@​sirosen](https://togithub.com/sirosen) made their first contribution in [https://github.com/codespell-project/codespell/pull/2822](https://togithub.com/codespell-project/codespell/pull/2822) - [@​andyholmes](https://togithub.com/andyholmes) made their first contribution in [https://github.com/codespell-project/codespell/pull/2466](https://togithub.com/codespell-project/codespell/pull/2466) - [@​nils-van-zuijlen](https://togithub.com/nils-van-zuijlen) made their first contribution in [https://github.com/codespell-project/codespell/pull/2848](https://togithub.com/codespell-project/codespell/pull/2848) - [@​sourcefrog](https://togithub.com/sourcefrog) made their first contribution in [https://github.com/codespell-project/codespell/pull/2859](https://togithub.com/codespell-project/codespell/pull/2859) - [@​ojeda](https://togithub.com/ojeda) made their first contribution in [https://github.com/codespell-project/codespell/pull/2870](https://togithub.com/codespell-project/codespell/pull/2870) - [@​claydugo](https://togithub.com/claydugo) made their first contribution in [https://github.com/codespell-project/codespell/pull/2873](https://togithub.com/codespell-project/codespell/pull/2873) - [@​Zac-HD](https://togithub.com/Zac-HD) made their first contribution in [https://github.com/codespell-project/codespell/pull/2875](https://togithub.com/codespell-project/codespell/pull/2875) **Full Changelog**: codespell-project/codespell@v2.2.4...v2.2.5 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/allenporter/flux-local). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xMTcuMyIsInVwZGF0ZWRJblZlciI6IjM1LjExNy4zIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Update the README to elaborate on case-sensitivity in ignored words
and dictionaries.
close #2451