search

SpiNNakerManchester / SupportScripts

Development scripts for the SpiNNaker project
Apache License 2.0
0 stars 2 forks source link

Spell checking #54

Closed dkfellows closed 1 year ago

dkfellows commented 1 year ago

This adds support for spell checking our Python docstrings (see https://github.com/SpiNNakerManchester/SpiNNUtils/pull/225).

To enable, add language: en_GB to the invocation of the pylint action (via with). You may also define a dictionary of words to be ignored; this is a text file of words, one per line (blank lines and #-started lines are ignored). The dictionary defaults to being called .pylint_dict.txt in the root of the project, but you can override this with dictionary: other_file.txt.

You may also need to add C0402,C0403 to the enable line in your .pylintrc.

dkfellows commented 1 year ago

This PR includes a default dictionary of words that crop up rather frequently in our docs (like int and bool and str and dict). Any dictionary you give is merged with that by the action.

You do not need to specify a dictionary. Failing a dictionary check is not fatal by default.

dkfellows commented 1 year ago

Also fixes a whole bunch of warnings in my IDE, which knows how to validate these YAML files.

dkfellows commented 1 year ago

Do not delete the branch yet!

Need to complete merge of uses first.