search

mongodb / specifications

Specifications related to MongoDB
http://specifications.readthedocs.io/en/latest
Other
389 stars 242 forks source link

DRIVERS-2790 Add more linting and integrity checks #1464

Closed blink1073 closed 10 months ago

blink1073 commented 1 year ago

We have been using pre-commit on the Python team for over a year and it has been a great help in development. It is optional for local use, but runs in CI.

I've added a minimal set of integrity checks, including making sure the docs build without warnings. As a follow on, we may wish to enable the end-of-file-fixer, trailing-whitespace, and check-json hooks and then add that commit to a .git-blame-ignore-revs file so it doesn't show up in git blame (GitHub also honors this file).

I've left out the rst-backticks check and codespell for now, but those will also be useful for correctness, for example:

source/index-management/index-management.rst:1109: interally ==> internally, integrally
source/client-side-operations-timeout/client-side-operations-timeout.rst:563: overridding ==> overriding
source/client-side-operations-timeout/client-side-operations-timeout.rst:564: explict ==> explicit
source/client-side-operations-timeout/client-side-operations-timeout.rst:895: consious ==> conscious
source/client-side-operations-timeout/client-side-operations-timeout.rst:923: similiar ==> similar
ShaneHarvey commented 10 months ago

Could you create a DRIVERS ticket to track this change?

blink1073 commented 10 months ago

Could you create a DRIVERS ticket to track this change?

Done and linked.