We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent da42ffb commit 78b858dCopy full SHA for 78b858d
doc/README.md
@@ -35,6 +35,8 @@ this guide.
35
(`[a link](http://example.com)`).
36
* When documenting APIs, update the YAML comment associated with the API as
37
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.
40
* For code blocks:
41
* Use [language][]-aware fences. (<code>\`\`\`js</code>)
42
0 commit comments