From ff56d83bc01766c7972bf5082c58d44b7480febe Mon Sep 17 00:00:00 2001 From: Kyle Zhang Date: Fri, 23 Aug 2024 00:59:11 +0800 Subject: [PATCH] Fix Doc issue for opexamples (#4201) Fix Doc issue for [#4192](https://github.com/microsoft/typespec/issues/4192) Co-authored-by: Kyle Zhang --- docs/standard-library/examples.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/standard-library/examples.md b/docs/standard-library/examples.md index 85dd97c35..afbfaccff 100644 --- a/docs/standard-library/examples.md +++ b/docs/standard-library/examples.md @@ -78,14 +78,14 @@ Operation example will not validate additional properties as the applicable para ### Simple operation parameters ```tsp -@example(#{ parameters: #{ name: "Max", age: 3 } }) +@opExample(#{ parameters: #{ name: "Max", age: 3 } }) op write(name: string, age: int32): void; ``` ### Simple operation return types ```tsp -@example(#{ returnType: #{ name: "Max", age: 3 } }) +@opExample(#{ returnType: #{ name: "Max", age: 3 } }) op read(): { name: string; age: int32; @@ -95,7 +95,7 @@ op read(): { ### Specify title and/or description ```tsp -@example( +@opExample( #{ parameters: #{ name: "Max", age: 3 } }, #{ title: "Simple write example", description: "Write a pet" } )