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

Grammar mistake #6201

Closed
1 task done
kq1231 opened this issue Nov 12, 2024 · 3 comments
Closed
1 task done

Grammar mistake #6201

kq1231 opened this issue Nov 12, 2024 · 3 comments
Labels
from.page-issue Reported in a reader-filed concern

Comments

@kq1231
Copy link

kq1231 commented Nov 12, 2024

Page URL

https://dart.dev/tools/linter-rules/use_build_context_synchronously.html

Page source

https://github.com/dart-lang/site-www/tree/main/src/content/tools/linter-rules/individual-rules.md

Describe the problem

There's a grammar mistake.

Expected fix

Storing BuildContext for later usage can easily lead to difficult-to-diagnose crashes. Asynchronous gaps are implicitly storing BuildContext and are some of the easiest to overlook when writing code.

"difficult-to-diagnose" should be hyphenated as it is a compound adjective describing "crashes."

Additional context

No response

I would like to fix this problem.

  • I will try and fix this problem on dart.dev.
@kq1231 kq1231 added the from.page-issue Reported in a reader-filed concern label Nov 12, 2024
@MaryaBelanger
Copy link
Contributor

@bwilkerson use_build_context_synchronously seems to be one of those shared names you explained to me recently. So, where do we apply this fix? I'm guessing in the shared name description in diagnostics.md. But I also see the same line under deprecatedDetails for one of the unique names in messages.yaml, so I'm just making sure. Thanks!

@bwilkerson
Copy link
Member

The source for the Diagnostic Messages page lives in the messages.yaml file in the linter package.

The diagnostic.md file is generated from the content in messages.yaml.

The deprecatedDetails section (also in messages.yaml) is what's published on https://dart.dev/tools/linter-rules/use_build_context_synchronously.

So it sounds like there are probably two places in the same file that need to be updated.

MaryaBelanger added a commit to dart-lang/sdk that referenced this issue Nov 14, 2024
@parlough
Copy link
Member

Resolved by dart-lang/sdk#57093 and dart-lang/sdk@107995f. Thanks all!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
from.page-issue Reported in a reader-filed concern
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants