fix(javadoc): fail and warn functions fix misleading documentation

danger / danger-js

⚠️ Stop saying "you forgot to …" in code review

http://danger.systems/js/

MIT License

5.22k stars 363 forks source link

fix(javadoc): fail and warn functions fix misleading documentation #1410

Closed Vacxe closed 8 months ago

Vacxe commented 8 months ago

References: https://github.com/danger/danger-js/blob/fdc1c49aff5e569580a23d0547ea0442a753826c/source/commands/utils/sharedDangerfileArgs.ts#L52 https://github.com/danger/danger-js/blob/fdc1c49aff5e569580a23d0547ea0442a753826c/source/runner/Executor.ts#L156

Behaviour: By default failOnErrors is false and will not fail run in case of any fails will be found. In this case current documentation is a bit misleading because users can expect different behaviour.

orta commented 8 months ago

Cool, this seems reasonable to me - thanks!