search

standardebooks / tools

The Standard Ebooks toolset for producing our ebook files.
Other
1.42k stars 125 forks source link

Linting run only containing "Manual Review" messages is considered failed #271

Closed nebulon42 closed 4 years ago

nebulon42 commented 4 years ago

Currently linting considers a linting run which has any amount of messages as failed (see https://github.com/standardebooks/tools/blob/master/se/commands/lint.py#L82). I would think that a linting run with messages of type "Manual Review" (and no errors) succeeded and should return a code of 0.

I'm happy to provide a patch if you agree with this observation.

acabal commented 4 years ago

I think if the command has output that requires user attention, i.e. it did not complete with silent success, then it should return an error code. This is useful in scripting situations where we need to know if the output requires attention. Ideally, when a user encounters a "manual review" item, and they judge it to not require correction, they would add an se-lint-ignore.xml file to ignore that error on future passes until lint is able to return 0.

Thanks for the suggestion though!