search

getodk / docs

The documentation for all the ODK tools. This is one of the most popular artifacts our community produces. It's built in Sphinx. ✨📚✨
https://docs.getodk.org/
Other
53 stars 157 forks source link

Triage through proselint checks to prepare a list of excluded checks #467

Closed ankita240796 closed 6 years ago

ankita240796 commented 6 years ago

In reference to #94, #427. Proselint checks: https://github.com/amperser/proselint/tree/master/proselint/checks

ankita240796 commented 6 years ago

@adammichaelwood We can mention the proselint checks to exclude here as well.

ankita240796 commented 6 years ago

Exclude the check: https://github.com/amperser/proselint/blob/master/proselint/checks/misc/but.py Prepare a custom check for this.

ankita240796 commented 6 years ago

Exclude: https://github.com/amperser/proselint/blob/master/proselint/checks/consistency/spelling.py as we already have a check for us vs uk spelling. Add any extra spelling found to the us vs uk check.

ankita240796 commented 6 years ago

@adammichaelwood I have gone through the checks in proselint. There is no such check which will create an issue with semantic line breaks. So, we can safely proceed with it. Further, there are three checks which are just commented out and there is no code as in this one: https://github.com/amperser/proselint/blob/master/proselint/checks/misc/usage.py But I think we can keep them on as in case of any update to these checks we may need to use them.

adammichaelwood commented 6 years ago

This work has been completed.