From f050b4c0d344faa53b5ed690654655041d51d21b Mon Sep 17 00:00:00 2001 From: Konstantin Aksenov Date: Wed, 1 Nov 2023 14:13:56 +1000 Subject: [PATCH] fix(javadoc): fail and warn functions fix misleading documentation --- source/runner/Dangerfile.ts | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/source/runner/Dangerfile.ts b/source/runner/Dangerfile.ts index 7494cee26..c44f0f678 100644 --- a/source/runner/Dangerfile.ts +++ b/source/runner/Dangerfile.ts @@ -27,7 +27,7 @@ export interface DangerContext { schedule(asyncFunction: Scheduleable): void /** - * Fails a build, outputting a specific reason for failing into a HTML table. + * Highlights critical issues. Message is shown inside a HTML table. * * @param {MarkdownString} message the String to output * @param {string | undefined} file a file which this message should be attached to @@ -36,8 +36,7 @@ export interface DangerContext { fail(message: MarkdownString, file?: string, line?: number): void /** - * Highlights low-priority issues, but does not fail the build. Message - * is shown inside a HTML table. + * Highlights low-priority issues. Message is shown inside a HTML table. * * @param {MarkdownString} message the String to output * @param {string | undefined} file a file which this message should be attached to