One shared guide for diagnostics.

One shared guide for diagnostics.

R=karlklose@google.com

Committed: https://github.com/dart-lang/sdk/commit/3835ccf9071c40646f8ea94b1f474b8febd359b8

[ahe, 2017-02-27 12:59:41]

ahe@google.com changed reviewers:
+ karlklose@google.com

[mit, 2017-02-27 13:14:05]

mit@google.com changed reviewers:
+ mit@google.com

[mit, 2017-02-27 13:14:05]

https://codereview.chromium.org/2718023003/diff/1/pkg/front_end/lib/src/fasta...
File pkg/front_end/lib/src/fasta/diagnostics.md (right):

https://codereview.chromium.org/2718023003/diff/1/pkg/front_end/lib/src/fasta...
pkg/front_end/lib/src/fasta/diagnostics.md:2: -- Copyright (c) 2016, the Dart
project authors.  Please see the AUTHORS file
Use 2017 for new files

https://codereview.chromium.org/2718023003/diff/1/pkg/front_end/lib/src/fasta...
pkg/front_end/lib/src/fasta/diagnostics.md:19: The message should be a complete
sentence starting with an uppercase letter, and ending with a period. The
message shouldn't start with "error:", "warning:", and so on.
Can we require all our diagnostic messages to start with a short, unique code?
That would make googling for help a lot easier.

For example, like in C#:
https://msdn.microsoft.com/en-us/library/ms228296(v=vs.90).aspx

[ahe, 2017-02-27 13:20:06]

Thank you, Michael!

https://codereview.chromium.org/2718023003/diff/1/pkg/front_end/lib/src/fasta...
File pkg/front_end/lib/src/fasta/diagnostics.md (right):

https://codereview.chromium.org/2718023003/diff/1/pkg/front_end/lib/src/fasta...
pkg/front_end/lib/src/fasta/diagnostics.md:2: -- Copyright (c) 2016, the Dart
project authors.  Please see the AUTHORS file
On 2017/02/27 13:14:05, mit wrote:
> Use 2017 for new files

Thank you, this comment was so last year.

https://codereview.chromium.org/2718023003/diff/1/pkg/front_end/lib/src/fasta...
pkg/front_end/lib/src/fasta/diagnostics.md:19: The message should be a complete
sentence starting with an uppercase letter, and ending with a period. The
message shouldn't start with "error:", "warning:", and so on.
On 2017/02/27 13:14:05, mit wrote:
> Can we require all our diagnostic messages to start with a short, unique code?
> That would make googling for help a lot easier.
> 
> For example, like in C#:
> https://msdn.microsoft.com/en-us/library/ms228296(v=vs.90).aspx

My gut reaction is that short unique error codes is a great idea, and this is
also what Florian started in package:dart_messages. It is also what I hope to do
long term.

However, I think this should be tracked as a separate task, and once we have the
mechanism in place, we should update this guide.

[ahe, 2017-03-02 13:42:34]

Ping

[karlklose, 2017-03-07 11:26:29]

LGTM

[ahe, 2017-03-07 12:44:45]

Description was changed from

==========
One shared guide for diagnostics.
==========

to

==========
One shared guide for diagnostics.

R=karlklose@google.com

Committed:
https://github.com/dart-lang/sdk/commit/3835ccf9071c40646f8ea94b1f474b8febd359b8
==========

[ahe, 2017-03-07 12:44:46]

Committed patchset #2 (id:20001) manually as
3835ccf9071c40646f8ea94b1f474b8febd359b8 (presubmit successful).