Improve the documentation for ParameterElement.isNotOptional
Change-Id: I3b46ceaef0360b3feffdc962ece7acac1dbada7e
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/241052
Reviewed-by: Lasse Nielsen <lrn@google.com>
Reviewed-by: Samuel Rawlins <srawlins@google.com>
Reviewed-by: Konstantin Shcheglov <scheglov@google.com>
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com>
diff --git a/pkg/analyzer/lib/dart/element/element.dart b/pkg/analyzer/lib/dart/element/element.dart
index a84c7ec..1246953 100644
--- a/pkg/analyzer/lib/dart/element/element.dart
+++ b/pkg/analyzer/lib/dart/element/element.dart
@@ -1523,9 +1523,11 @@
/// parameters are always positional, unless the experiment 'non-nullable' is
/// enabled, in which case named parameters can also be required.
///
- /// Note: regardless of the state of the 'non-nullable' experiment, this will
- /// return `false` for a named parameter that is annotated with the
- /// `@required` annotation.
+ /// Note: regardless of the state of the 'non-nullable' experiment, the
+ /// presence or absence of the `@required` annotation does not change the
+ /// meaning of this getter. The parameter `{@required int x}` will return
+ /// `false` and the parameter `{@required required int x}` will return
+ /// `true`
// TODO(brianwilkerson) Rename this to `isRequired`.
bool get isNotOptional;
