Skip to content

doc: document goal to have examples #42274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mhdawson wants to merge 4 commits into from
Closed

doc: document goal to have examples #42274

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fd80dbc
doc: document goal to have examples
mhdawson Mar 9, 2022
2bee87c
squash: address comments
mhdawson Mar 10, 2022
6196cfc
Update doc/README.md
mhdawson Mar 14, 2022
25a012a
Update doc/README.md
mhdawson Mar 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update doc/README.md
  • Loading branch information
@mhdawson
mhdawson authored Mar 14, 2022
commit 6196cfc4ef655efc4b82db3f1b554663ae55bd8d
2 changes: 1 addition & 1 deletion doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ 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.
* When documenting APIs, every function should have a usage example or link to an example that uses the function.
Comment thread
mhdawson marked this conversation as resolved.
Outdated
* For code blocks:
* Use [language][]-aware fences. (<code>\`\`\`js</code>)

Expand Down