Skip to content

Commit 6205c11

Browse files
authored
Remove "note that" in our documentation (as per style guide) (flutter#120842)
* lerp documentation * Remove Note, Note That from repo * Improve BorderSide documentation. * apply review comments
1 parent 9fe5567 commit 6205c11

File tree

72 files changed

+256
-206
lines changed

Some content is hidden

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

72 files changed

+256
-206
lines changed

dev/benchmarks/complex_layout/lib/src/app.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -630,7 +630,7 @@ class GalleryDrawer extends StatelessWidget {
630630
Widget build(BuildContext context) {
631631
final ScrollMode currentMode = ComplexLayoutApp.of(context)!.scrollMode;
632632
return Drawer(
633-
// Note: for real apps, see the Gallery material Drawer demo. More
633+
// For real apps, see the Gallery material Drawer demo. More
634634
// typically, a drawer would have a fixed header with a scrolling body
635635
// below it.
636636
child: ListView(

dev/benchmarks/microbenchmarks/lib/foundation/platform_asset_bundle.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ void main() async {
2424
watch.reset();
2525
watch.start();
2626
for (int i = 0; i < _kBatchSize; i += 1) {
27-
// Note: We don't load images like this. PlatformAssetBundle is used for
27+
// We don't load images like this. PlatformAssetBundle is used for
2828
// other assets (like Rive animations). We are using an image because it's
2929
// conveniently sized and available for the test.
3030
tally += (await bundle.load('packages/flutter_gallery_assets/places/india_pondicherry_salt_farm.png')).lengthInBytes;

dev/benchmarks/multiple_flutters/android/build.gradle

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ buildscript {
1313
classpath "com.android.tools.build:gradle:7.3.0"
1414
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
1515

16-
// NOTE: Do not place your application dependencies here; they belong
17-
// in the individual module build.gradle files
16+
// Do not place your application dependencies here; they belong
17+
// in the individual module build.gradle files.
1818
}
1919
}
2020

dev/bots/analyze.dart

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1842,7 +1842,7 @@ Future<void> verifyNullInitializedDebugExpensiveFields(String workingDirectory,
18421842
}
18431843
}
18441844

1845-
final RegExp tabooPattern = RegExp(r'^ *///.*\b(simply)\b', caseSensitive: false);
1845+
final RegExp tabooPattern = RegExp(r'^ *///.*\b(simply|note:|note that)\b', caseSensitive: false);
18461846

18471847
Future<void> verifyTabooDocumentation(String workingDirectory, { int minimumMatches = 100 }) async {
18481848
final List<String> errors = <String>[];
@@ -1859,7 +1859,8 @@ Future<void> verifyTabooDocumentation(String workingDirectory, { int minimumMatc
18591859
if (errors.isNotEmpty) {
18601860
foundError(<String>[
18611861
'${bold}Avoid the word "simply" in documentation. See https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#use-the-passive-voice-recommend-do-not-require-never-say-things-are-simple for details.$reset',
1862-
'${bold}In many cases the word can be omitted without loss of generality; in other cases it may require a bit of rewording to avoid implying that the task is simple.$reset',
1862+
'${bold}In many cases thes words can be omitted without loss of generality; in other cases it may require a bit of rewording to avoid implying that the task is simple.$reset',
1863+
'${bold}Similarly, avoid using "note:" or the phrase "note that". See https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#avoid-empty-prose for details.$reset',
18631864
...errors,
18641865
]);
18651866
}

dev/bots/docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ function script_location() {
1818

1919
function generate_docs() {
2020
# Install and activate dartdoc.
21-
# NOTE: When updating to a new dartdoc version, please also update
21+
# When updating to a new dartdoc version, please also update
2222
# `dartdoc_options.yaml` to include newly introduced error and warning types.
2323
"$DART" pub global activate dartdoc 6.1.5
2424

dev/ci/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ On each new change to this `Dockerfile`, Cirrus will build a new version of
99
the Docker image as a dependency to any Linux tests. It is no longer necessary
1010
to manually build and push the Docker image locally.
1111

12-
NOTE: there are some factors external to the actual `Dockerfile` that would
12+
There are some factors external to the actual `Dockerfile` that would
1313
necessitate rebuilding the Docker image, such as upstream code changes, (Linux
1414
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)

dev/conductor/core/lib/src/repository.dart

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,7 @@ abstract class Repository {
129129
'Fetch ${upstreamRemote.name} to ensure we have latest refs',
130130
workingDirectory: _checkoutDirectory!.path,
131131
);
132-
// Note: if [initialRef] is a remote ref the checkout will be left in a
133-
// detached HEAD state.
132+
// If [initialRef] is a remote ref, the checkout will be left in a detached HEAD state.
134133
await git.run(
135134
<String>['checkout', initialRef!],
136135
'Checking out initialRef $initialRef',

dev/conductor/core/test/start_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -531,7 +531,7 @@ void main() {
531531
'171876a4e6cf56ee6da1f97d203926bd7afda7ef';
532532
const String nextDartRevision =
533533
'f6c91128be6b77aef8351e1e3a9d07c85bc2e46e';
534-
// note that this significantly behind the candidate branch name
534+
// This is significantly behind the candidate branch name
535535
const String previousVersion = '0.9.0-1.0.pre';
536536
// This is what this release will be
537537
const String nextVersion = '0.9.0-1.1.pre';

dev/integration_tests/flutter_gallery/lib/gallery/example_code.dart

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
// Use of this source code is governed by a BSD-style license that can be
33
// found in the LICENSE file.
44

5-
// Note: This code is not runnable, it contains code snippets displayed in the
6-
// gallery.
5+
// This code is not runnable, it contains code snippets displayed in the Gallery.
76

87
import 'package:flutter/material.dart';
98

dev/integration_tests/ios_add2app_life_cycle/ios_add2app/FullScreenViewController.m

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ -(void)viewWillDisappear:(BOOL)animated {
2222
self.navigationController.navigationBarHidden = NO;
2323
self.navigationController.hidesBarsOnSwipe = NO;
2424
if (self.isMovingFromParentViewController) {
25-
// Note that if we were doing things that might cause the VC
25+
// If we were doing things that might cause the VC
2626
// to disappear (like using the image_picker plugin)
27-
// we shouldn't do this. But in this case we know we're
27+
// we shouldn't do this, but in this case we know we're
2828
// just going back to the navigation controller.
2929
// If we needed Flutter to tell us when we could actually go away,
3030
// we'd need to communicate over a method channel with it.

0 commit comments

Comments
 (0)