Check Correct Style and Spelling in Docstrings

[niccokunzmann]

The Vale spellchecker helps us already with writing documentation that is not misspelled and has a consistent style.

It is possible to configure Vale to also check the Python docstrings. They are part of the documentation too. Actually a huge part.

The following pull request showed considerable promise to resolve this issue, but was abandoned by the author. You could reopen the pull request and continue work on it.

#1111

To close this issue:

• configure Vale to run on the Python documentation
• It is not needed to run on test code or comments
• create a pull request and resolve the spelling mistakes
• possibly extend the accept list and reject lists of words

See also:

• https://vale.sh/docs/formats/code
• Add basic jcal conversion #979 (comment)_

[stevepiercy]

Just to clarify, I'm not confident that this will work, but it'd be good to try it out and see whether the result is helpful.