docs: clarify documentation

loopbackio · Jan 31, 2020 · 9ba74ed · 9ba74ed
1 parent 9a618ed
commit 9ba74ed
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/docs/site/decorators/Decorators_openapi.md b/docs/site/decorators/Decorators_openapi.md
@@ -456,7 +456,7 @@ class MyController {
 
 This namespace contains decorators that are specific to the OpenAPI
 specification, but are also similar to other well-known decorators available,
-such as `@oas.deprecated()`
+such as `@deprecated()`
 
 ### @oas.deprecated
 

diff --git a/packages/openapi-v3/src/decorators/deprecated.decorator.ts b/packages/openapi-v3/src/decorators/deprecated.decorator.ts
@@ -28,23 +28,22 @@ const debug = require('debug')(
  *
  * @example
  * ```ts
- * @deprecated()
+ * @oas.deprecated()
  * class MyController {
  *   @get('/greet')
  *   public async function greet() {
  *     return 'Hello, World!'
  *   }
  *
  *   @get('/greet-v2')
- *   @deprecated(false)
+ *   @oas.deprecated(false)
  *   public async function greetV2() {
  *     return 'Hello, World!'
  *   }
  * }
  *
  * class MyOtherController {
  *   @get('/echo')
- *   @deprecated()
  *   public async function echo() {
  *     return 'Echo!'
  *   }