From 12b8a1dc01ddd15066ebf082111b378d479c5c29 Mon Sep 17 00:00:00 2001 From: Chris Simpkins Date: Thu, 28 May 2020 16:16:34 -0400 Subject: [PATCH 1/2] add documentation of UI test error annotation substring support --- src/tests/adding.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/tests/adding.md b/src/tests/adding.md index e2a397a5b..e20d7fdc1 100644 --- a/src/tests/adding.md +++ b/src/tests/adding.md @@ -194,7 +194,10 @@ source. Error annotations specify the errors that the compiler is expected to emit. They are "attached" to the line in source where the error is located. Error annotations are considered during tidy lints of line -length and should be formatted according to tidy requirements. +length and should be formatted according to tidy requirements. You may +use an error message prefix sub-string if necessary to meet line length +requirements. Make sure that the text is long enough for the error +message to be self-documenting. The error annotation definition and source line definition association is defined with the following set of idioms: From efe6e794cebf24c9bb7d7a4fa9078704abf71b5e Mon Sep 17 00:00:00 2001 From: Chris Simpkins Date: Thu, 28 May 2020 17:10:21 -0400 Subject: [PATCH 2/2] Update src/tests/adding.md Co-authored-by: Yuki Okushi --- src/tests/adding.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/tests/adding.md b/src/tests/adding.md index e20d7fdc1..9dcb89326 100644 --- a/src/tests/adding.md +++ b/src/tests/adding.md @@ -196,7 +196,7 @@ emit. They are "attached" to the line in source where the error is located. Error annotations are considered during tidy lints of line length and should be formatted according to tidy requirements. You may use an error message prefix sub-string if necessary to meet line length -requirements. Make sure that the text is long enough for the error +requirements. Make sure that the text is long enough for the error message to be self-documenting. The error annotation definition and source line definition association