Suggest using lint for missing API docs (#1357)

dart-lang · Apr 30, 2024 · 9606f66 · 9606f66
1 parent 6caf291
commit 9606f66
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/lib/src/dartdoc/dartdoc.dart b/lib/src/dartdoc/dartdoc.dart
@@ -57,7 +57,10 @@ Future<Subsection> createDocumentationCoverageSection(
     summary.write('\n\n'
         'Providing good documentation for libraries, classes, functions, and other API '
         'elements improves code readability and helps developers find and use your API. '
-        'Document at least 20% of the public API elements.');
+        'Document at least 20% of the public API elements.'
+        '\n\n'
+        'To highlight public API members missing documentation consider enabling the '
+        '[`public_member_api_docs`](https://dart.dev/tools/linter-rules/public_member_api_docs) lint.');
   }
 
   if (symbolsMissingDocumentation != null &&