From 9d9c55925b6d2d5f804aa1a9565df1b0e9311555 Mon Sep 17 00:00:00 2001 From: Tierney Cyren Date: Fri, 8 Apr 2022 17:37:17 -0400 Subject: [PATCH] doc: re-add change from #42274 Signed-off-by: Tierney Cyren --- doc/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/README.md b/doc/README.md index 5c37a1ecdbe435..b923fd1581b34f 100644 --- a/doc/README.md +++ b/doc/README.md @@ -100,6 +100,9 @@ this guide. fragment of a clause. * 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. + ## API References