Skip to content

Commit

Permalink
Update mentions from 'dartdoc' to 'dart doc' (#3182)
Browse files Browse the repository at this point in the history
  • Loading branch information
parlough authored Feb 12, 2022
1 parent 6248895 commit f4d926d
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions lib/src/rules/avoid_renaming_method_parameters.dart
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ const _desc = r"Don't rename parameters of overridden methods.";
const _details = r'''**DON'T** rename parameters of overridden methods.
Methods that override another method, but do not have their own documentation
comment, will inherit the overridden method's comment when dartdoc produces
comment, will inherit the overridden method's comment when `dart doc` produces
documentation. If the inherited method contains the name of the parameter (in
square brackets), then dartdoc cannot link it correctly.
square brackets), then `dart doc` cannot link it correctly.
**BAD:**
```dart
Expand Down
2 changes: 1 addition & 1 deletion lib/src/rules/comment_references.dart
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const _details = r'''
**DO** reference only in scope identifiers in doc comments.
If you surround things like variable, method, or type names in square brackets,
then [dartdoc](https://dart.dev/guides/language/effective-dart/documentation) will look
then [`dart doc`](https://dart.dev/tools/dart-doc) will look
up the name and link to its docs. For this all to work, ensure that all
identifiers in docs wrapped in brackets are in scope.
Expand Down
2 changes: 1 addition & 1 deletion lib/src/rules/public_member_api_docs.dart
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ class Sub extends Base {
}
```
Note that consistent with `dartdoc`, an exception to the rule is made when
Note that consistent with `dart doc`, an exception to the rule is made when
documented getters have corresponding undocumented setters. In this case the
setters inherit the docs from the getters.
Expand Down

0 comments on commit f4d926d

Please sign in to comment.