site-www icon indicating copy to clipboard operation
site-www copied to clipboard

Add links from static analysis messages to diagnostic-messages?

Open kwalrath opened this issue 4 years ago • 2 comments

https://dart.dev/guides/language/sound-problems lists some static analysis messages. We used to auto-include them, but as of 2.9, we can't ignore errors (https://github.com/dart-lang/sdk/issues/42977), so we now avoid testing known bad code (#2575) and can't auto-include the messages.

To compensate a bit, we could link from the message in sound-problems to the message's entry in https://dart.dev/tools/diagnostic-messages. That way we could provide some more info and (if the message name changes) provide a way to find the new message.

/cc @bwilkerson @theacodes @johnpryan

kwalrath avatar Aug 14 '20 22:08 kwalrath

I was thinking this would be a great addition to provide more context, even though code excerpts are working for these errors now.

Do you think these should be naturally incorporated into the text or consistently outlined separately from the pre-existing text?

parlough avatar Oct 25 '21 04:10 parlough

Do you think these should be naturally incorporated into the text or consistently outlined separately from the pre-existing text?

If we're going to have literal output, I think it should be consistently separate from the explanatory (normal) text.

kwalrath avatar Oct 28 '21 00:10 kwalrath

@MaryaBelanger : Is this on your plan for updating the diagnostic messages?

atsansone avatar Apr 11 '23 21:04 atsansone

This is more related to future type system work since I imagine this article might get reworked or replaced in that.

parlough avatar Apr 12 '23 20:04 parlough