Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add links from static analysis messages to diagnostic-messages? #2579

Open
kwalrath opened this issue Aug 14, 2020 · 4 comments
Open

Add links from static analysis messages to diagnostic-messages? #2579

kwalrath opened this issue Aug 14, 2020 · 4 comments
Assignees
Labels
dev.type-system Relates to the type system in Dart e1-hours Can complete in < 8 hours of normal, not dedicated, work p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged t.diagnostics Relates to diagnostics, analysis, or linting of code

Comments

@kwalrath
Copy link
Contributor

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 (dart-lang/sdk#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 kwalrath added p2-medium Necessary but not urgent concern. Resolve when possible. e1-hours Can complete in < 8 hours of normal, not dedicated, work labels Aug 14, 2020
@parlough parlough self-assigned this Oct 25, 2021
@parlough
Copy link
Member

parlough commented Oct 25, 2021

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?

@kwalrath
Copy link
Contributor Author

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.

@atsansone
Copy link
Contributor

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

@atsansone atsansone added dev.null-safety Relates to transforming or migrating Dart code to sound null safety t.diagnostics Relates to diagnostics, analysis, or linting of code st.triage.ltw Indicates Lead Tech Writer has triaged labels Apr 11, 2023
@parlough
Copy link
Member

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

@parlough parlough added dev.type-system Relates to the type system in Dart and removed dev.null-safety Relates to transforming or migrating Dart code to sound null safety labels Apr 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev.type-system Relates to the type system in Dart e1-hours Can complete in < 8 hours of normal, not dedicated, work p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged t.diagnostics Relates to diagnostics, analysis, or linting of code
Projects
None yet
Development

No branches or pull requests

3 participants