From 0ed00a101bf7e249918a571f1eb48f49336c82e2 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 9 Mar 2022 17:33:20 -0500 Subject: [PATCH] doc: document goal to have examples As discussed in next-10 mini-summit on documentation see minutes where next steps were discussed - https://github.com/nodejs/next-10/blob/main/meetings/2022-02-16.md and minutes from summit - https://github.com/nodejs/next-10/blob/main/meetings/2022-02-16.md Signed-off-by: Michael Dawson PR-URL: https://github.com/nodejs/node/pull/42274 Reviewed-By: Rich Trott Reviewed-By: Mestery Reviewed-By: James M Snell Reviewed-By: Darshan Sen --- doc/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/README.md b/doc/README.md index a0f050ecd5cfc8..3d8ad6246839e6 100644 --- a/doc/README.md +++ b/doc/README.md @@ -35,6 +35,8 @@ this guide. (`[a link](http://example.com)`). * 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. * For code blocks: * Use [language][]-aware fences. (\`\`\`js)