OceanParcels
Decide on English spelling rules (and add to docsguide)?
Perhaps we should standardise the English spelling across our documentation? English-UK or English-US? Or English-AU??
I'd vote for English-UK, but am open to other suggestions
And is there any tooling to check this spelling rule?
Good idea
And is there any tooling to check this spelling rule?
- https://vale.sh/
- https://github.com/codespell-project/codespell
- https://cspell.org/
(not sure how they compare - from a glance Vale supports markdown, while the others support code (maybe markdown as well))
FWIW a maintainer of xarray considered codespell as a pre-commit hook https://github.com/pydata/xarray/pull/9781 (PR grew stale, so was therefore closed)
English-UK or English-US? Or English-AU??
A consideration is that a lot of Pangeo software comes out the US hence has US spelling (e.g., ...ize instead of ...ise, center instead of centre) and generally in Python code US spelling is more common. We do currently have a mix of US and UK spelling currently.
Not sure which way we should go - we can go either UK or US - but I agree consistency is good.
Sounds good, especially if we use tooling to check and fix it, since I think it is not such a large issue that we should spend checking things manually. I am happy to go either way, I mostly tend to write with US spelling myself.
