Broke up some larger paragraphs for easier reading. Made some additional sections to call out actionable work (since it seemed hidden within the paragraphs themselves).
Added some missing hyphens.
Change-Id: Icd84f16a6a6ff95e96e0423c83d7dbaedf7302bc
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/279323
Commit-Queue: Kallen Tu <kallentu@google.com>
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>
I thought it would be good to capture some of the information we have
about how the documentation for the analyzer diagnostics are currently
written.
I'm mostly interested in making sure that the description is clear.
We can update this if there are changes we decide to make going forward.
Change-Id: I27c78ce04fb86d0263a1081d7c8f42c3ebfa7b0a
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/278534
Reviewed-by: Phil Quitslund <pquitslund@google.com>
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com>
Reviewed-by: Marya Belanger <mbelanger@google.com>