Skip to content

Commit a60bf8e

Browse files
gspencergooggspencergoog
authored
Spell check of Flutter docs (flutter#45200)
No code changes, just comments: I spell-checked all the comments in the repo.
1 parent fcb40a0 commit a60bf8e

File tree

103 files changed

+188
-188
lines changed

Some content is hidden

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

103 files changed

+188
-188
lines changed

‎dev/bots/flutter_compact_formatter.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ class FlutterCompactFormatter {
5050
/// this is Windows or not outputting to a terminal.
5151
String get _noColor => useColor ? '\u001b[0m' : '';
5252

53-
/// The termianl escape for clearing the line, or a carriage return if
54-
/// this is Windows or not outputting to a termianl.
53+
/// The terminal escape for clearing the line, or a carriage return if
54+
/// this is Windows or not outputting to a terminal.
5555
String get _clearLine => useColor ? '\x1b[2K\r' : '\r';
5656

5757
final Map<int, TestResult> _tests = <int, TestResult>{};

‎dev/bots/test.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -961,7 +961,7 @@ Future<String> verifyVersion(File file) async {
961961
}
962962

963963
/// If the CIRRUS_TASK_NAME environment variable exists, we use that to determine
964-
/// the shard and subshard (parsing it in the form shard-subshard-platform, ignoring
964+
/// the shard and sub-shard (parsing it in the form shard-subshard-platform, ignoring
965965
/// the platform).
966966
///
967967
/// However, for local testing you can just set the SHARD and SUBSHARD

‎dev/devicelab/bin/tasks/gradle_plugin_dependencies_test.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import 'package:path/path.dart' as path;
1313
final String gradlew = Platform.isWindows ? 'gradlew.bat' : 'gradlew';
1414
final String gradlewExecutable = Platform.isWindows ? '.\\$gradlew' : './$gradlew';
1515

16-
/// Tests that projects can include plugins that have a transtive dependency in common.
16+
/// Tests that projects can include plugins that have a transitive dependency in common.
1717
/// For more info see: https://github.com/flutter/flutter/issues/27254.
1818
Future<void> main() async {
1919
await task(() async {

‎dev/devicelab/bin/tasks/gradle_r8_test.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import 'package:flutter_devicelab/framework/utils.dart';
1010
import 'package:path/path.dart' as path;
1111

1212
/// Tests that flutter build apk uses R8 by default by adding an
13-
/// invalid proguard rule and evaluating the error message.
13+
/// invalid ProGuard rule and evaluating the error message.
1414
Future<void> main() async {
1515
await task(() async {
1616

‎dev/devicelab/lib/framework/framework.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ bool _isTaskRegistered = false;
2525
/// The task does not run immediately but waits for the request via the
2626
/// VM service protocol to run it.
2727
///
28-
/// It is ok for a [task] to perform many things. However, only one task can be
28+
/// It is OK for a [task] to perform many things. However, only one task can be
2929
/// registered per Dart VM.
3030
Future<TaskResult> task(TaskFunction task) {
3131
if (_isTaskRegistered)
@@ -143,7 +143,7 @@ class _TaskRunner {
143143
});
144144
}
145145

146-
/// Disables the keep-alive port, allowing the VM to exit.
146+
/// Disables the keepalive port, allowing the VM to exit.
147147
void _closeKeepAlivePort() {
148148
_startTaskTimeout?.cancel();
149149
_keepAlivePort?.close();

‎dev/devicelab/lib/framework/utils.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,7 @@ int parseServicePort(String line, {
602602
return matches.isEmpty ? null : int.parse(matches[0].group(2));
603603
}
604604

605-
/// Tries to extract a Uri from the string.
605+
/// Tries to extract a URL from the string.
606606
///
607607
/// The `prefix`, if specified, is a regular expression pattern and must not contain groups.
608608
/// `prefix` defaults to the RegExp: `An Observatory debugger .* is available at: `.

‎examples/layers/rendering/src/sector_layout.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ class SectorParentData extends ParentData {
8888
/// * <https://en.wikipedia.org/wiki/Polar_coordinate_system>, which defines
8989
/// the polar coordinate space.
9090
/// * [RenderBox], which is the base class for [RenderObject]s that live in a
91-
/// cartesian coordinate space.
91+
/// Cartesian coordinate space.
9292
abstract class RenderSector extends RenderObject {
9393

9494
@override

‎packages/flutter/lib/src/cupertino/colors.dart

+4-4
Original file line numberDiff line numberDiff line change
@@ -642,7 +642,7 @@ class CupertinoColors {
642642
///
643643
/// {@tool sample}
644644
///
645-
/// The following code samples demostrate two cases where you have to manually
645+
/// The following code samples demonstrate two cases where you have to manually
646646
/// resolve a [CupertinoDynamicColor].
647647
///
648648
/// ```dart
@@ -926,16 +926,16 @@ class CupertinoDynamicColor extends Color with DiagnosticableMixin implements Di
926926
/// `data` is [CupertinoUserInterfaceLevelData.elevated]), the resolved
927927
/// [CupertinoDynamicColor] will be the same as this [CupertinoDynamicColor],
928928
/// except its effective color will be the `darkHighContrastElevatedColor` variant
929-
/// from the orignal [CupertinoDynamicColor].
929+
/// from the original [CupertinoDynamicColor].
930930
///
931931
/// Calling this function may create dependencies on the closest instance of some
932932
/// [InheritedWidget]s that enclose the given [BuildContext]. E.g., if [darkColor]
933933
/// is different from [color], this method will call [CupertinoTheme.of], and
934-
/// then [MediaQuery.of] if brightness wasn't specified in the theme data retrived
934+
/// then [MediaQuery.of] if brightness wasn't specified in the theme data retrieved
935935
/// from the previous [CupertinoTheme.of] call, in an effort to determine the
936936
/// brightness value.
937937
///
938-
/// If any of the required dependecies are missing from the given context, the
938+
/// If any of the required dependencies are missing from the given context, the
939939
/// default value of that trait will be used ([Brightness.light] platform
940940
/// brightness, normal contrast, [CupertinoUserInterfaceLevelData.base] elevation
941941
/// level), unless [nullOk] is set to false, in which case an exception will be

‎packages/flutter/lib/src/cupertino/date_picker.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -1273,7 +1273,7 @@ class CupertinoTimerPicker extends StatefulWidget {
12731273
/// Callback called when the timer duration changes.
12741274
final ValueChanged<Duration> onTimerDurationChanged;
12751275

1276-
/// Defines how the timper picker should be positioned within its parent.
1276+
/// Defines how the timer picker should be positioned within its parent.
12771277
///
12781278
/// This property must not be null. It defaults to [Alignment.center].
12791279
final AlignmentGeometry alignment;

‎packages/flutter/lib/src/cupertino/icons.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ class CupertinoIcons {
190190
/// A 25% charged battery.
191191
static const IconData battery_25_percent = IconData(0xf115, fontFamily: iconFont, fontPackage: iconFontPackage);
192192

193-
/// The bluetooth logo.
193+
/// The Bluetooth logo.
194194
static const IconData bluetooth = IconData(0xf116, fontFamily: iconFont, fontPackage: iconFontPackage);
195195

196196
/// A restart arrow, pointing downwards.

‎packages/flutter/lib/src/cupertino/picker.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ class CupertinoPicker extends StatefulWidget {
172172

173173
/// {@macro flutter.rendering.wheelList.squeeze}
174174
///
175-
/// Defaults to `1.45` fo visually mimic iOS.
175+
/// Defaults to `1.45` to visually mimic iOS.
176176
final double squeeze;
177177

178178
/// An option callback when the currently centered item changes.

‎packages/flutter/lib/src/cupertino/text_field.dart

+3-3
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,13 @@ enum OverlayVisibilityMode {
6868

6969
/// Overlay will only appear when the current text entry is not empty.
7070
///
71-
/// This includes pre-filled text that the user did not type in manually. But
71+
/// This includes prefilled text that the user did not type in manually. But
7272
/// does not include text in placeholders.
7373
editing,
7474

7575
/// Overlay will only appear when the current text entry is empty.
7676
///
77-
/// This also includes not having pre-filled text that the user did not type
77+
/// This also includes not having prefilled text that the user did not type
7878
/// in manually. Texts in placeholders are ignored.
7979
notEditing,
8080

@@ -178,7 +178,7 @@ class _CupertinoTextFieldSelectionGestureDetectorBuilder extends TextSelectionGe
178178
class CupertinoTextField extends StatefulWidget {
179179
/// Creates an iOS-style text field.
180180
///
181-
/// To provide a pre-filled text entry, pass in a [TextEditingController] with
181+
/// To provide a prefilled text entry, pass in a [TextEditingController] with
182182
/// an initial value to the [controller] parameter.
183183
///
184184
/// To provide a hint placeholder text that appears when the text entry is

‎packages/flutter/lib/src/cupertino/theme.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ class CupertinoThemeData extends Diagnosticable {
277277
);
278278
}
279279

280-
/// Returns a new `CupertinoThemeData` with all its colors resolved aginst the
280+
/// Returns a new `CupertinoThemeData` with all its colors resolved against the
281281
/// given [BuildContext].
282282
///
283283
/// Called by [CupertinoTheme.of] to resolve colors defined in the retrieved

‎packages/flutter/lib/src/foundation/_bitfield_web.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import 'bitfield.dart' as bitfield;
66

77
/// The dart:html implementation of [bitfield.kMaxUnsignedSMI].
88
///
9-
/// This value is used as an optimization to coerse some numbers to be within
9+
/// This value is used as an optimization to coerce some numbers to be within
1010
/// the SMI range and avoid heap allocations. Because number encoding is
1111
/// VM-specific, there's no guarantee that this optimization will be effective
1212
/// on all JavaScript engines. The value picked here should be correct, but it

‎packages/flutter/lib/src/foundation/assertions.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -772,7 +772,7 @@ void debugPrintStack({StackTrace stackTrace, String label, int maxFrames}) {
772772
debugPrint(FlutterError.defaultStackFilter(lines).join('\n'));
773773
}
774774

775-
/// Diagnostic with a [StackTrace] [value] suitable for displaying stacktraces
775+
/// Diagnostic with a [StackTrace] [value] suitable for displaying stack traces
776776
/// as part of a [FlutterError] object.
777777
///
778778
/// See also:

‎packages/flutter/lib/src/foundation/constants.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ const bool kReleaseMode = bool.fromEnvironment('dart.vm.product', defaultValue:
1818
/// compiled in Dart with the '-Ddart.vm.profile=true' flag.
1919
///
2020
/// Since this is a const value, it can be used to indicate to the compiler that
21-
/// a particular block of code will not be executed in profle mode, an hence
21+
/// a particular block of code will not be executed in profile mode, an hence
2222
/// can be removed.
2323
const bool kProfileMode = bool.fromEnvironment('dart.vm.profile', defaultValue: false);
2424

‎packages/flutter/lib/src/foundation/debug.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ int debugDoublePrecision;
8585

8686
/// Formats a double to have standard formatting.
8787
///
88-
/// This behavior can be overriden by [debugDoublePrecision].
88+
/// This behavior can be overridden by [debugDoublePrecision].
8989
String debugFormatDouble(double value) {
9090
if (value == null) {
9191
return 'null';

‎packages/flutter/lib/src/foundation/diagnostics.dart

+3-3
Original file line numberDiff line numberDiff line change
@@ -1056,7 +1056,7 @@ bool _isSingleLine(DiagnosticsTreeStyle style) {
10561056
return style == DiagnosticsTreeStyle.singleLine;
10571057
}
10581058

1059-
/// Renderer that creates ascii art representations of trees of
1059+
/// Renderer that creates ASCII art representations of trees of
10601060
/// [DiagnosticsNode] objects.
10611061
///
10621062
/// See also:
@@ -1385,7 +1385,7 @@ class TextTreeRenderer {
13851385
/// Defines diagnostics data for a [value].
13861386
///
13871387
/// For debug and profile modes, [DiagnosticsNode] provides a high quality
1388-
/// multi-line string dump via [toStringDeep]. The core members are the [name],
1388+
/// multiline string dump via [toStringDeep]. The core members are the [name],
13891389
/// [toDescription], [getProperties], [value], and [getChildren]. All other
13901390
/// members exist typically to provide hints for how [toStringDeep] and
13911391
/// debugging tools should format output.
@@ -3352,7 +3352,7 @@ abstract class DiagnosticableTree extends Diagnosticable {
33523352
///
33533353
/// `joiner` specifies the string which is place between each part obtained
33543354
/// from [debugFillProperties]. Passing a string such as `'\n '` will result
3355-
/// in a multi-line string that indents the properties of the object below its
3355+
/// in a multiline string that indents the properties of the object below its
33563356
/// name (as per [toString]).
33573357
///
33583358
/// `minLevel` specifies the minimum [DiagnosticLevel] for properties included

‎packages/flutter/lib/src/foundation/profile.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import 'basic_types.dart';
66
import 'constants.dart';
77

8-
/// DEPRECATED. `function` cannot be treeshaken out of release builds.
8+
/// DEPRECATED. `function` cannot be tree-shaken out of release builds.
99
///
1010
/// Instead use:
1111
///

‎packages/flutter/lib/src/gestures/events.dart

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export 'dart:ui' show Offset, PointerDeviceKind;
1212
/// The bit of [PointerEvent.buttons] that corresponds to a cross-device
1313
/// behavior of "primary operation".
1414
///
15-
/// More specifially, it includes:
15+
/// More specifically, it includes:
1616
///
1717
/// * [kTouchContact]: The pointer contacts the touch screen.
1818
/// * [kStylusContact]: The stylus contacts the screen.
@@ -135,7 +135,7 @@ int nthStylusButton(int number) => (kPrimaryStylusButton << (number - 1)) & kMax
135135

136136
/// Returns the button of `buttons` with the smallest integer.
137137
///
138-
/// The `buttons` parameter is a bitfield where each set bit represents a button.
138+
/// The `buttons` parameter is a bit field where each set bit represents a button.
139139
/// This function returns the set bit closest to the least significant bit.
140140
///
141141
/// It returns zero when `buttons` is zero.
@@ -155,7 +155,7 @@ int smallestButton(int buttons) => buttons & (-buttons);
155155

156156
/// Returns whether `buttons` contains one and only one button.
157157
///
158-
/// The `buttons` parameter is a bitfield where each set bit represents a button.
158+
/// The `buttons` parameter is a bit field where each set bit represents a button.
159159
/// This function returns whether there is only one set bit in the given integer.
160160
///
161161
/// It returns false when `buttons` is zero.
@@ -170,7 +170,7 @@ int smallestButton(int buttons) => buttons & (-buttons);
170170
///
171171
/// See also:
172172
///
173-
/// * [smallestButton], which returns the button in a `buttons` bitfield with
173+
/// * [smallestButton], which returns the button in a `buttons` bit field with
174174
/// the smallest integer button.
175175
bool isSingleButton(int buttons) => buttons != 0 && (smallestButton(buttons) == buttons);
176176

‎packages/flutter/lib/src/material/app_bar.dart

+4-4
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ class AppBar extends StatefulWidget implements PreferredSizeWidget {
253253
/// If leading widget is not null, this parameter has no effect.
254254
final bool automaticallyImplyLeading;
255255

256-
/// The primary widget displayed in the appbar.
256+
/// The primary widget displayed in the app bar.
257257
///
258258
/// Typically a [Text] widget containing a description of the current contents
259259
/// of the app.
@@ -952,7 +952,7 @@ class SliverAppBar extends StatefulWidget {
952952
/// If leading widget is not null, this parameter has no effect.
953953
final bool automaticallyImplyLeading;
954954

955-
/// The primary widget displayed in the appbar.
955+
/// The primary widget displayed in the app bar.
956956
///
957957
/// Typically a [Text] widget containing a description of the current contents
958958
/// of the app.
@@ -997,7 +997,7 @@ class SliverAppBar extends StatefulWidget {
997997
/// Typically a [FlexibleSpaceBar]. See [FlexibleSpaceBar] for details.
998998
final Widget flexibleSpace;
999999

1000-
/// This widget appears across the bottom of the appbar.
1000+
/// This widget appears across the bottom of the app bar.
10011001
///
10021002
/// Typically a [TabBar]. Only widgets that implement [PreferredSizeWidget] can
10031003
/// be used at the bottom of an app bar.
@@ -1155,7 +1155,7 @@ class SliverAppBar extends StatefulWidget {
11551155
/// a scroll dismisses the app bar, the animation will slide the app bar
11561156
/// completely out of view.
11571157
///
1158-
/// Snapping only applies when the app bar is floating, not when the appbar
1158+
/// Snapping only applies when the app bar is floating, not when the app bar
11591159
/// appears at the top of its scroll view.
11601160
///
11611161
/// ## Animated Examples

‎packages/flutter/lib/src/material/banner.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import 'theme.dart';
1717
/// to be dismissed.
1818
///
1919
/// Banners should be displayed at the top of the screen, below a top app bar.
20-
/// They are persistent and nonmodal, allowing the user to either ignore them or
20+
/// They are persistent and non-modal, allowing the user to either ignore them or
2121
/// interact with them at any time.
2222
///
2323
/// The [actions] will be placed beside the [content] if there is only one.

‎packages/flutter/lib/src/material/bottom_sheet.dart

+3-3
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ class BottomSheet extends StatefulWidget {
9090
final WidgetBuilder builder;
9191

9292
/// If true, the bottom sheet can be dragged up and down and dismissed by
93-
/// swiping downards.
93+
/// swiping downwards.
9494
///
9595
/// Default is true.
9696
final bool enableDrag;
@@ -497,11 +497,11 @@ Future<T> showModalBottomSheet<T>({
497497
/// this method.
498498
///
499499
/// The new bottom sheet becomes a [LocalHistoryEntry] for the enclosing
500-
/// [ModalRoute] and a back button is added to the appbar of the [Scaffold]
500+
/// [ModalRoute] and a back button is added to the app bar of the [Scaffold]
501501
/// that closes the bottom sheet.
502502
///
503503
/// To create a persistent bottom sheet that is not a [LocalHistoryEntry] and
504-
/// does not add a back button to the enclosing Scaffold's appbar, use the
504+
/// does not add a back button to the enclosing Scaffold's app bar, use the
505505
/// [Scaffold.bottomSheet] constructor parameter.
506506
///
507507
/// A closely related widget is a modal bottom sheet, which is an alternative

‎packages/flutter/lib/src/material/button_bar.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ class ButtonBar extends StatelessWidget {
186186
/// there is not enough horizontal space.
187187
///
188188
/// It first attempts to lay out its buttons as though there were no
189-
/// maximumm width constraints on the widget. If the button bar's width is
189+
/// maximum width constraints on the widget. If the button bar's width is
190190
/// less than the maximum width constraints of the widget, it then lays
191191
/// out the widget as though it were placed in a [Row].
192192
///
@@ -249,7 +249,7 @@ class _ButtonBarRow extends Flex {
249249
/// there is not enough horizontal space.
250250
///
251251
/// It first attempts to lay out its buttons as though there were no
252-
/// maximumm width constraints on the widget. If the button bar's width is
252+
/// maximum width constraints on the widget. If the button bar's width is
253253
/// less than the maximum width constraints of the widget, it then lays
254254
/// out the widget as though it were placed in a [Row].
255255
///

‎packages/flutter/lib/src/material/input_decorator.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -2971,7 +2971,7 @@ class InputDecoration {
29712971
/// If provided, this replaces the semantic label of the [counterText].
29722972
final String semanticCounterText;
29732973

2974-
/// Typically set to true when the [InputDecorator] contains a multi-line
2974+
/// Typically set to true when the [InputDecorator] contains a multiline
29752975
/// [TextField] ([TextField.maxLines] is null or > 1) to override the default
29762976
/// behavior of aligning the label with the center of the [TextField].
29772977
///
@@ -3585,7 +3585,7 @@ class InputDecorationTheme extends Diagnosticable {
35853585
/// rounded rectangle around the input decorator's container.
35863586
final InputBorder border;
35873587

3588-
/// Typically set to true when the [InputDecorator] contains a multi-line
3588+
/// Typically set to true when the [InputDecorator] contains a multiline
35893589
/// [TextField] ([TextField.maxLines] is null or > 1) to override the default
35903590
/// behavior of aligning the label with the center of the [TextField].
35913591
final bool alignLabelWithHint;

‎packages/flutter/lib/src/material/list_tile.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ enum ListTileControlAffinity {
440440
///
441441
/// {@tool snippet --template=stateless_widget_scaffold}
442442
///
443-
/// Here is an example of an article list item with multi-line titles and
443+
/// Here is an example of an article list item with multiline titles and
444444
/// subtitles. It utilizes [Row]s and [Column]s, as well as [Expanded] and
445445
/// [AspectRatio] widgets to organize its layout.
446446
///

‎packages/flutter/lib/src/material/range_slider.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ class RangeSlider extends StatefulWidget {
273273
/// There are two labels: one for the start thumb and one for the end thumb.
274274
///
275275
/// Each label is rendered using the active [ThemeData]'s
276-
/// [ThemeData.accentTextTheme.body2] text style, and can be overriden
276+
/// [ThemeData.accentTextTheme.body2] text style, and can be overridden
277277
/// by changing the [SliderThemeData.valueIndicatorTextStyle].
278278
///
279279
/// If null, then the value indicator will not be displayed.

0 commit comments

Comments
 (0)