First Dart Tutorial mention of analysis_options.yaml shoud refer to a straightforward explanation of the linter. #6907
Description
Page URL
https://dart.dev/tools/linter-rules/unawaited_futures
Page source
No response
Describe the problem
Not exactly an error, but an improvement. Considering that the discarded_futures and unawaited_futures are the first mentions of analysis_options.yaml in the Dart tutorial, it would make sense to mention (or link to something that mentions) how analysis_options.yaml works. I see after starting this report that there is a link, but the important details are buried in the text.
Expected fix
In particular, making prominent that the linter searches toward the root of the directory tree to find the first mention of linter rules. Including the implications (YAML lists are preferable for maintenance reasons; converting the list to a YAML map becomes necessary when a "false" needs to appear in the list; commenting out a list item does not disable it, it just reverts to default behavior - which actually may be specified further toward the root; sorting the "false" entries to the end of each coherent set of options makes it more maintainable).
Additional context
I won't opt to make this sort of change, because I'm a beginner, and I would likely unintentionally violate a plethora of rules (formatting, style choices, phrasing conventions, etc.). When I find typographical errors, that would make a good foray into personally fixing the documentation.
I would like to fix this problem.
- I will try and fix this problem on dart.dev.