-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Closed
Labels
c: docsImprovements or additions to documentationImprovements or additions to documentationc: featureRequest for new featureRequest for new feature
Milestone
Description
Clear and concise description of the problem
Most (if not all) of the functions already have JSDoc, but these are just simple e.g. @param <fieldName> without the descriptive text.
We found some documentation like #160, https://fakerjs.dev/api/datatype and e.g. these schema definitions that were just for generating documentation.
Suggested solution
We would like to write these messages to the JSDoc comments, so that IDEs like VSCode can provide them via tooltips.
Alternative
No response
Additional context
After this is done, we think that we can remove the schema definitions.
| Module | Assignees | #PR | Done |
|---|---|---|---|
| address.ts | @mbokinala, @ST-DDT | #230 | ✔️ |
| animal.ts | @mbokinala | #250, #417 | ✔️ |
| commerce.ts | @ST-DDT | #351 | ✔️ |
| company.ts | @ST-DDT | #423 | ✔️ |
| database.ts | @ST-DDT | #424 | ✔️ |
| datatype.ts | @pkuczynski | #337 | ✔️ |
| date.ts | @ST-DDT | #427 | ✔️ |
| fake.ts | @ST-DDT | #406 | ✔️ |
| finance.ts | @ST-DDT | #434 | ✔️ |
| git.ts | @ST-DDT | #435 | ✔️ |
| hacker.ts | @ST-DDT | #436 | ✔️ |
| helpers.ts | @ST-DDT | #442 | ✔️ |
| image.ts | @ST-DDT | #437 | ✔️ |
| internet.ts | @ST-DDT | #447 | ✔️ |
| lorem.ts | @ST-DDT | #458 | ✔️ |
| mersenne.ts | @ST-DDT | #438 | ✔️ |
| music.ts | @ST-DDT | #390 | ✔️ |
| name.ts | @ST-DDT | #391 | ✔️ |
| phone.ts | @pkuczynski | #397 | ✔️ |
| random.ts | @pkuczynski @ST-DDT | #408 #562 | ✔️ |
| system.ts | @pkuczynski | #298 | ✔️ |
| time.ts | @pkuczynski | #288 | ✔️ |
| unique.ts | @ST-DDT | #439 | ✔️ |
| vehicle.ts | @pkuczynski | #274 | ✔️ |
| word.ts | @pkuczynski | #273 | ✔️ |
Metadata
Metadata
Assignees
Labels
c: docsImprovements or additions to documentationImprovements or additions to documentationc: featureRequest for new featureRequest for new feature