doc: re-add change from nodejs#42274

Signed-off-by: Tierney Cyren <hello@bnb.im>
bnb · Apr 8, 2022 · 9d9c559 · 9d9c559
1 parent 401f993
commit 9d9c559
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/doc/README.md b/doc/README.md
@@ -100,6 +100,9 @@ this guide.
     fragment of a clause.
 * When documenting APIs, update the YAML comment associated with the API as
   appropriate. This is especially true when introducing or deprecating an API.
+* When documenting APIs, every function should have a usage example or
+  link to an example that uses the function.
+
 
 ## API References