Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Nov 1, 2023

Conversation

Vacxe
Copy link
Member

@Vacxe Vacxe commented Nov 1, 2023

References:

.option("-f, --failOnErrors", "Fail if there are fails in the danger report", false)

if (this.options.failOnErrors && results.fails.length > 0) {

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.

@Vacxe Vacxe requested a review from orta November 1, 2023 04:24
@orta
Copy link
Member

orta commented Nov 1, 2023

Cool, this seems reasonable to me - thanks!

@orta orta merged commit 263bcd2 into danger:main Nov 1, 2023
2 checks passed
@Vacxe Vacxe deleted the fix-misleading-javadoc branch November 6, 2023 05:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants