Skip to content

Commit 78b858d

Browse files
mhdawsonbengl
authored andcommitted
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 <mdawson@devrus.com> PR-URL: #42274 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
1 parent da42ffb commit 78b858d

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

doc/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ this guide.
3535
(`[a link](http://example.com)`).
3636
* When documenting APIs, update the YAML comment associated with the API as
3737
appropriate. This is especially true when introducing or deprecating an API.
38+
* When documenting APIs, every function should have a usage example or
39+
link to an example that uses the function.
3840
* For code blocks:
3941
* Use [language][]-aware fences. (<code>\`\`\`js</code>)
4042

0 commit comments

Comments
 (0)