codespell: Avoid project-level ignore words if possible#4691
Conversation
seisman
added
maintenance
| NI = 17 #: GMT netCDF format (32-bit integer) | ||
| NF = 18 #: GMT netCDF format (32-bit float) | ||
| ND = 19 #: GMT netCDF format (64-bit float) | ||
| ND = 19 #: GMT netCDF format (64-bit float) # codespell:ignore |
There was a problem hiding this comment.
The codespell syntax for inline igore (xref: https://github.com/codespell-project/codespell#inline-ignore).
| GridFormat.NI, | ||
| GridFormat.NF, | ||
| GridFormat.ND, | ||
| GridFormat.ND, # codespell:ignore |
There was a problem hiding this comment.
The codespell syntax for inline igore (xref: https://github.com/codespell-project/codespell#inline-ignore).
|
|
||
| fig.colorbar( | ||
| cmap="SCM/buda", | ||
| cmap="SCM/hawaii", |
There was a problem hiding this comment.
Any CPT can be used in this file. Choose SCM/hawaii so that codespell doesn't report buda.
| **M**\ (iles), or **n**\ (autical miles) [Default is (m)\ **e**\ (ters)]. | ||
| - For projected data (**X**\|\ **Y**\|\ **D**), the unit may be | ||
| **i**\ (nches), **c**\ (entimeters), or **p**\ (oints). | ||
| **i** (inches), **c** (centimeters), or **p** (points). |
There was a problem hiding this comment.
We will likely get more false positives if we keep using the syntax like **i**\ (nches). I think we should try our best to avoid using it in the future.
|
|
||
| [tool.codespell] | ||
| ignore-words-list = "astroid,buda,oints,reenable,te,tripel,trough,ND" | ||
| ignore-words-list = "astroid,te,tripel,trough" |
There was a problem hiding this comment.
We can't use the inline ignore syntax (# codespell:ignore) for these words because they are used in the documentation. Otherwise, the ignore comments would appear in the code examples shown in the docs.
2 participants
This PR tries to shorten the project-level ignore words list for codespell.