Skip to content

Commit 36ff80c

Browse files
committed
chore: fix tag order
1 parent 01dd2a8 commit 36ff80c

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,11 @@ JSDoc will be read and automatically processed by `generate:api-docs` and theref
8181
> We have a small set of JSDoc tags that all methods should have.
8282
8383
- Description
84-
- `@see` - If there are other important methods
8584
- `@param` - If the method has parameters
85+
- `@see` - If there are other important methods
8686
- `@example` - Example calls without and with parameters, including a sample result each
87-
- `@deprecated` - If the method is deprecated, with additional information about replacements
8887
- `@since` - The version this method was added (or is likely to be added)
88+
- `@deprecated` - If the method is deprecated, with additional information about replacements
8989

9090
<table>
9191
<tr>
@@ -99,15 +99,17 @@ JSDoc will be read and automatically processed by `generate:api-docs` and theref
9999
/**
100100
* This is a good JSDoc description for a method that generates foos.
101101
*
102-
* @see faker.helper.fake
103-
*
104102
* @param options The optional options to use.
105103
* @param options.test The parameter to configure test. Defaults to `'bar'`.
106104
*
105+
* @see faker.helper.fake
106+
*
107107
* @example
108108
* faker.bar.foo() // 'foo'
109109
* faker.bar.foo({ test: 'oof' }) // 'of'
110110
*
111+
* @since 7.5.0
112+
*
111113
* @deprecated Use faker.cat.random() instead.
112114
*/
113115
function foo(options: { test: string } = {}): string {

0 commit comments

Comments
 (0)