Deploy Check Spelling https://github.com/libprima/PRIMA.jl/issues/11

[zaikunzhang]

No description provided.

[github-advanced-security]

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

[emmt]

I do not fully understand all the implications of trigerring this tool. For instance, can we restrict the checks to the comments and the documentation? It nevertheless seems to be useful as it fixed a few typos in the comments (some of these have been fixed in PR #17 so I expect some conflicts).

[zaikunzhang]

[Sorry @emmt , it seems that I edited your comment when I meant to respond to it. It is restored. My response is as follows.]

I do not fully understand all the implications of trigerring this tool. For instance, can we restrict the checks to the comments and the documentation? It nevertheless seems to be useful as it fixed a few typos in the comments (some of these have been fixed in PR #17 so I expect some conflicts).

The scope can be configured by modifying the files in .github/actions/spelling. In particular,

allow.txt: false positives
pattern.txt: patterns to exclude
exclude.txt: files to exclude
I do not know how to ask it to check only specific files. If that is desired, an issue should be open at https://github.com/check-spelling/check-spelling

For instance, can we restrict the checks to the comments

I suppose not. The idea of this action is particular to check the code. It will try to understand your code, and exclude the keywords of the language. This is done by dictionaries corresponding to the language. However, unfortunately, Julia does not have a dictionary yet.

[emmt]

Let us be pragmatic and add false positives as they appear.