fix a doc issue for opExample (microsoft#4773)

It should be `@opExample` instead of `@example`.
swatkatz · Nov 5, 2024 · 8c3b345 · 8c3b345
1 parent 7cad3bc
commit 8c3b345
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 3 deletions.
diff --git a/.chronus/changes/fix-doc-issue-2024-9-18-11-26-56.md b/.chronus/changes/fix-doc-issue-2024-9-18-11-26-56.md
@@ -0,0 +1,7 @@
+---
+changeKind: internal
+packages:
+  - "@typespec/compiler"
+---
+
+Fix typo in opExample decorator example
diff --git a/packages/compiler/generated-defs/TypeSpec.ts b/packages/compiler/generated-defs/TypeSpec.ts
@@ -618,7 +618,7 @@ export type ExampleDecorator = (
  * @param options Optional metadata for the example.
  * @example
  * ```tsp
- * @example(#{parameters: #{name: "Fluffy", age: 2}, returnType: #{name: "Fluffy", age: 2, id: "abc"})
+ * @opExample(#{parameters: #{name: "Fluffy", age: 2}, returnType: #{name: "Fluffy", age: 2, id: "abc"})
  * op createPet(pet: Pet): Pet;
  * ```
  */

diff --git a/packages/compiler/lib/std/decorators.tsp b/packages/compiler/lib/std/decorators.tsp
@@ -570,7 +570,7 @@ model OperationExample {
  * @example
  *
  * ```tsp
- * @example(#{parameters: #{name: "Fluffy", age: 2}, returnType: #{name: "Fluffy", age: 2, id: "abc"})
+ * @opExample(#{parameters: #{name: "Fluffy", age: 2}, returnType: #{name: "Fluffy", age: 2, id: "abc"})
  * op createPet(pet: Pet): Pet;
  * ```
  */

diff --git a/website/src/content/docs/docs/standard-library/built-in-decorators.md b/website/src/content/docs/docs/standard-library/built-in-decorators.md
@@ -632,7 +632,7 @@ Provide example values for an operation's parameters and corresponding return ty
 #### Examples
 
 ```tsp
-@example(#{parameters: #{name: "Fluffy", age: 2}, returnType: #{name: "Fluffy", age: 2, id: "abc"})
+@opExample(#{parameters: #{name: "Fluffy", age: 2}, returnType: #{name: "Fluffy", age: 2, id: "abc"})
 op createPet(pet: Pet): Pet;
 ```