docs: fix typos in flutter_tools comments#186321
Conversation
(sytax, vesion, dynamiclly, successfuly, Documenation, prefered, Wether, overriden, tha). Comment-only; no semantic or behavior changes. Affected files: - packages/flutter_tools/lib/src/android/gradle_utils.dart (8 fixes) - packages/flutter_tools/lib/src/features.dart (2 fixes) - packages/flutter_tools/lib/src/linux/linux_doctor.dart (1 fix)
There was a problem hiding this comment.
Code Review
This pull request fixes several typos in the documentation comments within the Flutter tools package. The review feedback identifies further opportunities to improve comment readability and grammar, such as capitalizing proper nouns like 'Flutter' and 'KGP', hyphenating compound adjectives, and using semicolons to correct comma splices.
| // Instead the kgpVersion task is a custom flutter task dynamically added that can | ||
| // print the kgp version if gradle can run successfully. |
There was a problem hiding this comment.
Adding a comma after the introductory word "Instead" improves readability. Additionally, "Flutter" and "KGP" should be capitalized as they are proper nouns, consistent with their usage elsewhere in the codebase.
| // Instead the kgpVersion task is a custom flutter task dynamically added that can | |
| // print the kgp version if gradle can run successfully. | |
| // Instead, the kgpVersion task is a custom Flutter task dynamically added that can | |
| // print the KGP version if gradle can run successfully. |
References
- Optimize for readability: Code is read more often than it is written. (link)
|
|
||
| // https://kotlinlang.org/docs/gradle-configure-project.html#apply-the-plugin | ||
| // Documenation is non continuous, past versions are known to the | ||
| // Documentation is non continuous, past versions are known to the |
There was a problem hiding this comment.
The compound adjective "non-continuous" should be hyphenated. Also, replacing the comma with a semicolon fixes a comma splice, improving grammatical correctness and readability.
| // Documentation is non continuous, past versions are known to the | |
| // Documentation is non-continuous; past versions are known to the |
References
- Optimize for readability: Code is read more often than it is written. (link)
|
|
||
| // https://kotlinlang.org/docs/gradle-configure-project.html#apply-the-plugin | ||
| // Documenation is non continuous, past versions are known to the | ||
| // Documentation is non continuous, past versions are known to the |
There was a problem hiding this comment.
The compound adjective "non-continuous" should be hyphenated. Also, replacing the comma with a semicolon fixes a comma splice, improving grammatical correctness and readability.
| // Documentation is non continuous, past versions are known to the | |
| // Documentation is non-continuous; past versions are known to the |
References
- Optimize for readability: Code is read more often than it is written. (link)
|
The Gemini suggestions do also seem good, but they can be in a follow up PR if someone is interested in making it. |
Summary
Fixes a handful of single-word typos found in
///dartdoc and//inline comments insideflutter_tools. Comment-only — no public API, no behavior, no test logic touched.Changes
packages/flutter_tools/lib/src/android/gradle_utils.dartspace sytax->space syntaxThis vesion is NOT->This version is NOTdynamiclly added->dynamically addedgradle can run successfuly->gradle can run successfullyDocumenation is non continuous->Documentation is non continuous(2 occurrences)KGP version handling is prefered->KGP version handling is preferred(2 occurrences)packages/flutter_tools/lib/src/features.dartWether riscv64 support is enabled->Whether riscv64 support is enabledThis member is overriden in google3->This member is overridden in google3packages/flutter_tools/lib/src/linux/linux_doctor.dartRequires tha [binary]->Requires that [binary]Tests
No tests added or modified. The change does not touch any executable line. Verified locally by re-grepping the modified files for residual instances of each typo — none remain.
Notes for maintainers
material/orcupertino/paths are touched, so the active code freeze is not impacted.Pre-launch Checklist