add documentation of UI test error annotation substring support

This commit is contained in:
Chris Simpkins 2020-05-28 16:16:34 -04:00 committed by Who? Me?!
parent f086b737ef
commit 154e750ec5
1 changed files with 4 additions and 1 deletions

View File

@ -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: