Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 78b858d

Browse filesBrowse 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
Copy full SHA for 78b858d

File tree

Expand file treeCollapse file tree

1 file changed

+2
-0
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+2
-0
lines changed
Open diff view settings
Collapse file

‎doc/README.md‎

Copy file name to clipboardExpand all lines: doc/README.md
+2Lines changed: 2 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
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 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.