Improve option name/description of assert-valid

daisy / pipeline-scripts

!! NOTE: This project is now part of the pipeline-modules project !! | Script modules for the default DAISY Pipeline 2 distribution.

GNU Lesser General Public License v3.0

6 stars 5 forks source link

Improve option name/description of assert-valid #111

Closed bertfrees closed 1 year ago

bertfrees commented 7 years ago

See comment by Sean:

Quick suggestion: I feel the terminology "assert validity" could be confusing from an end-user standpoint. The option description and documentation is clear, but the option's name itself could be taken to mean that the user is asserting the validity of the document, not the script. I know it was modeled after existing XProc steps like this one, but something along the lines of "Abort on Validation" or "Strict Validation" might be more clear and user-friendly.

bertfrees commented 6 years ago

Maybe all scripts should have a "Input validation" option with 3 possible values: "No validation", "Report validation errors" and "Abort on validation errors".