Skip to content

Commit d41b1fb

Browse files
βœ’ Spell Check All .md Files Related to Flutter πŸ’™ (flutter#61564)
* πŸ› Fix Spelling Issues in Main README.md * πŸ› Fix spelling issues in dev README.md * πŸ› Fix spelling issues in complex_layout README.md * πŸ› Fix spelling issues in macrobenchmarks README.md * πŸ› Fix spelling issues in platform_views_layout README.md * πŸ› Fix spelling issues in test_Apps/stocks README.md * πŸ› Fix spelling issues in bots README.md * βœ’ Spell Check dev/ci README.md * βœ’ Spell Check dev/ci/docker_linux README.md * βœ’ Spell Check dev/devicelab README.md * βœ’ Spell Check dev/docs README.md * βœ’ Spell Check dev/snippets README.md * βœ’ Spell Check dev/snippets/config/templates README.md * βœ’ Spell Check dev/tools/gen_keycodes README.md * βœ’ Spell Check dev/tools/vitool README.md * βœ’ Spell Check examples/catalog README.md * βœ’ Spell Check examples/flutter_view README.md * βœ’ Spell Check examples/image_list README.md * βœ’ Spell Check examples/layers README.md * βœ’ Spell Check examples/platform_channel README.md * βœ’ Spell Check examples/platform_channel_swift README.md * βœ’ Spell Check examples/platform_view README.md * βœ’ Spell Check packages/_flutter_web_build_script README.md * βœ’ Spell Check packages/flutter_localizations README.md * βœ’ Spell Check packages/flutter_tools README.md * βœ’ Spell Check CODE_OF_CONDUCT.md * βœ’ Spell Check dev/integration_test/android_splash_screens/splash_Screen_load_rotate README.md * βœ’ Spell Check dev/integration_test/android_views README.md * βœ’ Spell Check dev/integration_tests/flutter_driver_screenshot_test README.md * βœ’ Spell Check dev/integration_tests/flutter_gallery README.md * βœ’ Spell Check dev/integration_tests/gradle_deprecated_settings README.md * βœ’ Spell Check dev/integration_tests/ios_add2app_life_cycle README.md * βœ’ Spell Check dev/integration_tests/ios_host_app README.md * βœ’ Spell Check dev/integration_tests/ios_platform_view_tests README.md * βœ’ Spell Check dev/automated_tests/flutter_test README.md * βœ’ Spell Check .github/PULL_REQUEST_TEMPLATE.md * βœ’ Spell Check .hithub/ISSUE_TEMPLATE/ACTIVATION.md * βœ’ Spell Check .github/ISSUE_TEMPLATE/BUG.md * βœ’ Spell Check .github/ISSUE_TEMPLATE/feature_request.md * βœ’ Spell Check .github/ISSUE_TEMPLATE/performance_others.md * βœ’ Spell Check .github/ISSUE_TEMPLATE/performance_speed.md * βœ’ Spell Check packages/flutter_tools/doc/daemon.md * βœ’ Spell Check packages/flutter_tools/fuchsia_enrtypoint_shim/README.md * βœ’ Minimize line to 80 columns * βœ’ Minimize line to 80 columns * βœ’ Fix Typo * βœ’ Chnaged numbers to 1 for testing purposes * βœ’ Changed numbers to 1 for testing purposes * ❌ Remove 'a' which is a typo * βœ’ Change a sentence to be better * βœ’ Remove 'a' which is a typo * βœ’ Fix small issue * βœ’ Fix small typo * βœ’ Fix some typos * ❌ Remove trailing space * ❌ Remove trailing space * πŸ› Fix small typo * βœ’ Fix Typo * πŸ› Fix small bug
1 parent 9f04086 commit d41b1fb

File tree

43 files changed

+258
-230
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+258
-230
lines changed

β€Ž.github/ISSUE_TEMPLATE/ACTIVATION.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ assignees: ''
1818
* https://stackoverflow.com/questions/tagged/flutter?sort=frequent
1919
2020
If you have found a bug or if our documentation doesn't have an answer
21-
to what you're looking for, then fill our the template below. Please read
21+
to what you're looking for, then fill out the template below. Please read
2222
our guide to filing a bug first: https://flutter.dev/docs/resources/bug-reports
2323
-->
2424

β€Ž.github/ISSUE_TEMPLATE/BUG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ assignees: ''
1717
* https://stackoverflow.com/questions/tagged/flutter?sort=frequent
1818
1919
If you have found a bug or if our documentation doesn't have an answer
20-
to what you're looking for, then fill our the template below. Please read
20+
to what you're looking for, then fill out the template below. Please read
2121
our guide to filing a bug first: https://flutter.dev/docs/resources/bug-reports
2222
-->
2323

β€Ž.github/ISSUE_TEMPLATE/feature_request.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ assignees: ''
1616
* https://stackoverflow.com/questions/tagged/flutter?sort=frequent
1717
1818
If you have found a bug or if our documentation doesn't have an answer
19-
to what you're looking for, then fill our the template below. Please read
19+
to what you're looking for, then fill out the template below. Please read
2020
our guide to filing a bug first: https://flutter.dev/docs/resources/bug-reports
2121
-->
2222

@@ -29,7 +29,7 @@ assignees: ''
2929
Is your feature request related to a problem? Please give a clear and
3030
concise description of what the problem is.
3131
32-
Describe alternative solutions you've considered. Is there a package
32+
Describe the alternative solutions you've considered. Is there a package
3333
on pub.dev/flutter that already solves this?
3434
-->
3535

β€Ž.github/ISSUE_TEMPLATE/performance_others.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ assignees: ''
1515
* https://api.flutter.dev/
1616
* https://stackoverflow.com/questions/tagged/flutter?sort=frequent
1717
18-
If you have found a performance problem, then fill our the template below.
18+
If you have found a performance problem, then fill out the template below.
1919
Please read our guide to filing a bug first: https://flutter.dev/docs/resources/bug-reports
2020
-->
2121

@@ -39,7 +39,7 @@ assignees: ''
3939
<!--
4040
Please tell us which target platform(s) the problem occurs (Android / iOS / Web / macOS / Linux / Windows)
4141
Which target OS version, for Web, browser, is the test system running?
42-
Does the problem occur on emulator/simulator as well as on physical devices?
42+
Does the problem occur on an emulator/simulator as well as on physical devices?
4343
-->
4444

4545
**Target Platform:**

β€Ž.github/ISSUE_TEMPLATE/performance_speed.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ assignees: ''
1616
* https://api.flutter.dev/
1717
* https://stackoverflow.com/questions/tagged/flutter?sort=frequent
1818
19-
If you have found a performance problem, then fill our the template below.
19+
If you have found a performance problem, then fill out the template below.
2020
Please read our guide to filing a bug first: https://flutter.dev/docs/resources/bug-reports
2121
-->
2222

β€Ž.github/PULL_REQUEST_TEMPLATE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010

1111
I added the following tests:
1212

13-
*Replace this with a list of the tests that you added as part of this PR. A change in behaviour with no test covering it
13+
*Replace this with a list of the tests that you added as part of this PR. A change in behavior with no test covering it
1414
will likely get reverted accidentally sooner or later. PRs must include tests for all changed/updated/fixed behaviors. See [Test Coverage].*
1515

1616
## Checklist
1717

18-
Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (`[x]`). This will ensure a smooth and quick review process.
18+
Before you create this PR, confirm that it meets all requirements listed below by checking the relevant checkboxes (`[x]`). This will ensure a smooth and quick review process.
1919

2020
- [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
2121
- [ ] I signed the [CLA].

β€ŽCODE_OF_CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,6 @@ an expert in all the systems. Once you find the answer, document it in
4444
the first place you looked. That way, the next person will be brought
4545
up to speed even quicker.
4646

47-
!["I try not to make fun of people for admitting they don't know things, because for each thing 'everyone knows' by the time they're adults, every day there are, on average, 10,000 people in the US hearing about it for the first time. If I make fun of people, I train them not to tell me when they have those moments. And I miss out on the fun." "Diet coke and mentos thing? What's that?" "Oh man! We're going to the grocery store." "Why?" "You're one of today's lucky 10,000."](https://imgs.xkcd.com/comics/ten_thousand.png)
47+
!["I try not to make fun of people for admitting they don't know things, because for each thing 'everyone knows' by the time they're adults, every day there are, on average, 10,000 people in the US hearing about it for the first time. If I make fun of people, I train them not to tell me when they have those moments. And I miss out on the fun." "Diet coke and mentos thing? What's that?" "Oh, man! We're going to the grocery store." "Why?" "You're one of today's lucky 10,000."](https://imgs.xkcd.com/comics/ten_thousand.png)
4848

4949
Source: _[xkcd, May 2012](https://xkcd.com/1053/)_

β€ŽREADME.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Twitter handle][]][Twitter badge]
66

77
Flutter is Google's SDK for crafting beautiful, fast user experiences for
8-
mobile, web and desktop from a single codebase. Flutter works with existing
8+
mobile, web, and desktop from a single codebase. Flutter works with existing
99
code, is used by developers and organizations around the world, and is free
1010
and open source.
1111

@@ -30,17 +30,17 @@ extensible and open development model.
3030
We want to enable designers to deliver their full creative vision without being
3131
forced to water it down due to limitations of the underlying framework.
3232
Flutter's [layered architecture] gives you control over every pixel on the
33-
screen, and its powerful compositing capabilities let you overlay and animate
34-
graphics, video, text and controls without limitation. Flutter includes a full
33+
screen and its powerful compositing capabilities let you overlay and animate
34+
graphics, video, text, and controls without limitation. Flutter includes a full
3535
[set of widgets][widget catalog] that deliver pixel-perfect experiences on both
3636
iOS and Android.
3737

3838
![Reflectly hero image][Reflectly hero image]
3939

4040
### Fast results
4141

42-
Flutter is fast. It's powered by the same hardware-accelerated [Skia] 2D
43-
graphics library that underpins Chrome and Android. We architected Flutter to
42+
Flutter is fast. It's powered by the same hardware-accelerated 2D graphics
43+
library that underpins Chome and Android: [Skia]. We architected Flutter to
4444
support glitch-free, jank-free graphics at the native speed of your device.
4545
Flutter code is powered by the world-class [Dart platform], which enables
4646
compilation to 32-bit and 64-bit ARM machine code for iOS and Android, as well
@@ -57,13 +57,13 @@ and see the results instantly without restarting your app or losing its state.
5757

5858
### Extensible and open model
5959

60-
Flutter works with any development tool (or none at all), but includes editor
60+
Flutter works with any development tool (or none at all) but includes editor
6161
plug-ins for both [Visual Studio Code] and [IntelliJ / Android Studio]. Flutter
6262
provides [thousands of packages][Flutter packages] to speed your development,
6363
regardless of your target platform. And accessing other native code is easy,
6464
with support for both [FFI] and [platform-specific APIs][platform channels].
6565

66-
Flutter is a fully open source project, and we welcome contributions.
66+
Flutter is a fully open-source project, and we welcome contributions.
6767
Information on how to get started can be found at our
6868
[contributor guide](CONTRIBUTING.md).
6969

β€Ždev/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
This directory contains tools and resources that the Flutter team uses
2-
during development of the framework. The tools in this directory
2+
during the development of the framework. The tools in this directory
33
should not be necessary for developing Flutter applications, though of
4-
course they may be interesting if you are curious.
4+
course, they may be interesting if you are curious.
55

66
The tests in this directory are run in the `framework_tests_misc-*`
77
shards.
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
The files in this directory are used as part of tests in the
1+
The files in this directory are used as part of the tests in the
22
`flutter_tools` package. Some are here because here these tests need a
33
`pubspec.yaml` that references the flutter framework (which is
44
intentionally not true of the `flutter_tools` package). Others are
5-
here mostly out of peer pressure.
5+
here mostly out of peer pressure.

β€Ždev/benchmarks/complex_layout/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@ To measure startup time on a device:
2121
flutter run --profile --trace-startup
2222
```
2323

24-
Results should be in the logs.
24+
The results should be in the logs.
2525

2626
Additional results should be in the file `build/start_up_info.json`.

β€Ždev/benchmarks/macrobenchmarks/README.md

+32-5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,33 @@ Performance benchmarks use either flutter drive or the web benchmark harness.
44

55
## Mobile benchmarks
66

7+
### Cull opacity benchmark
8+
9+
To run the cull opacity benchmark on a device:
10+
11+
```
12+
flutter drive --profile test_driver/cull_opacity_perf.dart
13+
```
14+
15+
Results should be in the file `build/cull_opacity_perf.timeline_summary.json`.
16+
17+
More detailed logs should be in `build/cull_opacity_perf.timeline.json`.
18+
19+
### Cubic bezier benchmark
20+
21+
To run the cubic-bezier benchmark on a device:
22+
23+
```
24+
flutter drive --profile test_driver/cubic_bezier_perf.dart
25+
```
26+
27+
Results should be in the file `build/cubic_bezier_perf.timeline_summary.json`.
28+
29+
More detailed logs should be in `build/cubic_bezier_perf.timeline.json`.
30+
31+
### Backdrop filter benchmark
32+
33+
To run the backdrop filter benchmark on a device:
734
To run a mobile benchmark on a device:
835

936
```
@@ -30,7 +57,7 @@ The key `[test_name]` can be:
3057

3158
## Web benchmarks
3259

33-
Web benchmarks are compiled from the same entrypoint in `lib/web_benchmarks.dart`.
60+
Web benchmarks are compiled from the same entry point in `lib/web_benchmarks.dart`.
3461

3562
### How to write a web benchmark
3663

@@ -39,13 +66,13 @@ as an example.
3966

4067
Choose one of the two benchmark types:
4168

42-
* A "raw benchmark" records performance metrics from direct interactions with
69+
- A "raw benchmark" records performance metrics from direct interactions with
4370
`dart:ui` with no framework. This kind of benchmark is good for benchmarking
4471
low-level engine primitives, such as layer, picture, and semantics performance.
45-
* A "widget benchmark" records performance metrics using a widget. This kind of
72+
- A "widget benchmark" records performance metrics using a widget. This kind of
4673
benchmark is good for measuring the performance of widgets, often together with
4774
engine work that widget-under-test incurs.
48-
* A "widget build benchmark" records the cost of building a widget from nothing.
75+
- A "widget build benchmark" records the cost of building a widget from nothing.
4976
This is different from the "widget benchmark" because typically the latter
5077
only performs incremental UI updates, such as an animation. In contrast, this
5178
benchmark pumps an empty frame to clear all previously built widgets and
@@ -83,7 +110,7 @@ flutter run --profile -d web-server lib/web_benchmarks.dart
83110
flutter run --dart-define=FLUTTER_WEB_USE_SKIA=true --profile -d web-server lib/web_benchmarks.dart
84111
```
85112

86-
You can also run all benchmarks exactly like the devicelab runs them:
113+
You can also run all benchmarks exactly as the devicelab runs them:
87114

88115
```
89116
cd dev/devicelab

β€Ždev/benchmarks/platform_views_layout/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@ To measure startup time on a device:
2121
flutter run --profile --trace-startup
2222
```
2323

24-
Results should be in the logs.
24+
The results should be in the logs.
2525

2626
Additional results should be in the file `build/start_up_info.json`.

β€Ždev/benchmarks/test_apps/stocks/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ the tool is used to generate localizations for this app.
3030

3131
## Icon
3232

33-
Icon was created using Android Asset Studio:
33+
The icon was created using Android Asset Studio:
3434
https://romannurik.github.io/AndroidAssetStudio/icons-launcher.html#foreground.type=image&foreground.space.trim=0&foreground.space.pad=0&foreColor=607d8b%2C0&crop=0&backgroundShape=square&backColor=fff%2C100&effects=none
3535

3636
From this clipart:
3737
https://openclipart.org/detail/30403/tango-go-up
38-
Which is public domain.
38+
Which is in the public domain.

β€Ždev/bots/README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ This directory exists to support building Flutter on our build infrastructure.
44

55
The results of such builds are viewable at:
66
* https://cirrus-ci.com/github/flutter/flutter/master
7-
- Testing done on PRs and submitted changes on GitHub.
7+
- Testing is done on PRs and submitted changes on GitHub.
88
* https://ci.chromium.org/p/flutter/
9-
- Additional testing and processing done after changes are submitted.
9+
- Additional testing and processing are done after changes are submitted.
1010

1111
The LUCI infra requires permissions to retrigger or schedule builds. Contact
1212
@kf6gpe or another Google member of the Flutter team if you need to do that.
@@ -29,7 +29,7 @@ machines and what kind are managed internally by Google. Contact @kf6gpe or
2929
another Google member of the Flutter team if you suspect changes are needed
3030
there. Both of these technologies are highly specific to the [LUCI](https://github.com/luci)
3131
project, which is the successor to Chromium's infra. We're just borrowing some
32-
of their infrastructure.
32+
of their infrastructures.
3333

3434
### Prerequisites
3535

@@ -39,17 +39,17 @@ To work on this infrastructure you will need:
3939
- Python package installer: `sudo apt-get install python-pip`
4040
- Python coverage package (only needed for `training_simulation`): `sudo pip install coverage`
4141

42-
To run prepare_package.dart locally:
42+
To run `prepare_package.dart` locally:
4343

44-
- Make sure the depot_tools is in your PATH. If you're on Windows, you also need
45-
an environment variable called DEPOT_TOOLS with the path to depot_tools as value.
44+
- Make sure the `depot_tools` is in your `PATH`. If you're on Windows, you also need
45+
an environment variable called `DEPOT_TOOLS` with the path to `depot_tools` as value.
4646
- Run `gsutil.py config` (or `python %DEPOT_TOOLS%\gsutil.py` on Windows) to
4747
authenticate with your auth token.
4848
- Create a local temp directory. `cd` into it.
4949
- Run `dart [path to your normal Flutter repo]/dev/bots/prepare_package.dart
5050
--temp_dir=. --revision=[revision to package] --branch=[branch to deploy to]
5151
--publish`.
52-
- If you're running into gsutil permission issues, check with @Hixie to make sure
52+
- If you're running into `gsutil` permission issues, check with @Hixie to make sure
5353
you have the right push permissions.
5454

5555
### Getting the code
@@ -81,22 +81,22 @@ and
8181

8282
Recipes are just Python with some limitations on what can be imported. They are
8383
[documented](https://github.com/luci/recipes-py/blob/master/doc/user_guide.md)
84-
by the [luci/recipes-py github project](https://github.com/luci/recipes-py).
84+
by the [luci/recipes-py GitHub project](https://github.com/luci/recipes-py).
8585

8686
The typical cycle for editing a recipe is:
8787

88-
1. Checkout the recipes project using `git clone https://flutter.googlesource.com/recipes`.
88+
1. Check out the recipes project using `git clone https://flutter.googlesource.com/recipes`.
8989
2. Make your edits (probably to files in
9090
`//recipes/recipes`).
9191
3. Update the tests. Run `recipes.py test train` to update
92-
existing expected output to match the new output. Verify completely new test
92+
the existing expected output to match the new output. Verify completely new test
9393
cases by altering the `GenTests` method of the recipe. The recipe is required
9494
to have 100% test coverage.
9595
4. Run `led get-builder 'luci.flutter.prod:BUILDER_NAME' | led edit -p 'revision="GIT_HASH"' | led edit-recipe-bundle | led launch`, where `BUILDER_NAME` is the builder name (e.g. `Linux Engine`), and
9696
`GIT_HASH` is the hash to build (which is important for the engine but not
9797
for the framework).
9898
5. To submit a CL, you need a local branch first (`git checkout -b [some branch name]`).
99-
6. Upload the patch (`git commit`, `git cl upload`) and send it to someone in
99+
6. Upload the patch (`git commit`, `git cl upload`), and send it to someone in
100100
the `OWNERS` file for review.
101101

102102
### The infra config repository
@@ -112,7 +112,7 @@ schema that describes available properties.
112112

113113
### Future Directions
114114

115-
We would like to host our own recipes instead of storing them in
115+
We would like to host our recipes instead of storing them in
116116
[build](https://chromium.googlesource.com/chromium/tools/build.git/+/master/scripts/slave/recipes/flutter).
117117
Support for [cross-repository
118118
recipes](https://github.com/luci/recipes-py/blob/master/doc/cross_repo.md) is
@@ -123,7 +123,7 @@ tried, but it's not quite ready.
123123
### Android Tools
124124

125125
The Android SDK and NDK used by Flutter's Chrome infra bots are stored in Google
126-
Cloud. During the build a bot runs the `download_android_tools.py` script that
126+
Cloud. During the build, a bot runs the `download_android_tools.py` script that
127127
downloads the required version of the Android SDK into `dev/bots/android_tools`.
128128

129129
To check which components are currently installed, download the current SDK
@@ -216,8 +216,8 @@ want to do, run:
216216
$ dart ./unpublish_package.dart --confirm --temp_dir=/tmp/foo --revision d444a455de87a2e40b7f576dc12ffd9ab82fd491
217217
```
218218

219-
and it will actually perform the actions. You will of course need to have access
220-
to the cloud storage server and have gsutil installed in order to perform this
219+
and it will perform the actions. You will of course need to have access
220+
to the cloud storage server and have `gsutil` installed to perform this
221221
operation. Only runs on Linux or macOS systems.
222222

223223
See `dart ./unpublish_package.dart --help` for more details.

β€Ždev/ci/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ to manually build and push the Docker image locally.
1111

1212
NOTE: there are some factors external to the actual `Dockerfile` that would
1313
necessitate rebuilding the Docker image, such as upstream code changes, (Linux
14-
distribution) repository updates, or a file that gets `COPY`ied into the image
14+
distribution) repository updates or a file that gets `COPY`ied into the image
1515
changing. In this case, a trivial `Dockerfile` change (such as a comment)
1616
would invalidate the cache and trigger a rebuild.

β€Ždev/ci/docker_linux/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
This directory includes scripts to build the docker container image used for
22
building flutter/flutter in our CI system (currently [Cirrus](cirrus-ci.org)).
33

4-
In order to run the scripts, you have to setup `docker` and `gcloud`. Please
5-
refer to the [internal flutter team doc](go/flutter-team) for how to setup in a
4+
To run the scripts, you have to set up `docker` and `gcloud`. Please
5+
refer to the [internal flutter team doc](go/flutter-team) for how to set up in a
66
Google internal environment.
77

88
To debug the image locally:

0 commit comments

Comments
Β (0)