languages/dart-sdk
languages/dart-sdk
1
0
Fork 0
mirror of https://github.com/dart-lang/sdk synced 2024-10-03 06:21:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Key string should be avoided

Browse source 
Change-Id: I0708ac8bd7aa8c6993bb329b212b400a6f55cae9
Reviewed-on: https://dart-review.googlesource.com/60424
Reviewed-by: Dmitry Stefantsov <dmitryas@google.com>
Commit-Queue: Peter von der Ahé <ahe@google.com>
This commit is contained in:
Peter von der Ahé 2018-06-15 10:03:24 +00:00 committed by commit-bot@chromium.org
parent 1e906c3f7e
commit b51d3d4146
2 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
pkg/front_end/lib/src/fasta/diagnostics.md
View file

@ -41,7 +41,9 @@ Also, remember that the output isn't Markdown, so be careful to not use Markdown
## Avoid Composing Messages Programmatically
Composing messages programmatically can make it hard to translate them.
Composing messages programmatically can make it hard to translate them. A tool that compose messages programmatically also makes it hard for its clients to distinguish the diagnostics.
For example, [messages.yaml](../../../messages.yaml) includes an error code named `Unspecified`. This code is useful when prototyping a new diagnostic, but shouldn't otherwise be used.
## Keep Message Short

6
pkg/front_end/messages.yaml
View file

@ -64,6 +64,9 @@
# `#lexeme` a token. The token's `lexeme` property is used.
#
# `#string`, `#string2`, `#string3`: strings (that aren't names).
# Note: as a rule of thumb, avoid using the `#string` keys. In particular,
# do not use them for composing error messages, see [diagnostics.md](
# lib/src/fasta/diagnostics.md#avoid-composing-messages-programmatically).
#
# `#type`, #type2`: Kernel types.
#
@ -864,6 +867,9 @@ UnterminatedToken:
template: "Incomplete token."
dart2jsCode: UNTERMINATED_TOKEN
# Note: avoid using this template, it should only be used for debugging and
# prototyping, see [diagnostics.md](
# lib/src/fasta/diagnostics.md#avoid-composing-messages-programmatically).
Unspecified:
template: "#string"
dart2jsCode: GENERIC