-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Closed
Labels
c: docsImprovements or additions to documentationImprovements or additions to documentationp: 1-normalNothing urgentNothing urgents: acceptedAccepted feature / Confirmed bugAccepted feature / Confirmed bug
Milestone
Description
Clear and concise description of the problem
Currently, the documentation only provides a single example per invocation, this could result in wrong expectations of method return values.
See:
Suggested solution
Adding a refresh button to the example sections:
apidocs-refresh-button.mp4
For that to work, we have to
- trigger downloading of the latest faker version (on first press)
- change our apidocs json data to be js/ts, so that we can store actual code in there
- add a function
() => unknown[]
to the export data from the actual examples - take each result JSON.stringify it and insert into the code block
Alternative
Add more examples for the no args examples.
Additional context
Original issue:
Original fix suggestion:
Alternative suggestion for a fix:
github-actions, sounmind and xDivisionByZeroxxDivisionByZerox
Metadata
Metadata
Assignees
Labels
c: docsImprovements or additions to documentationImprovements or additions to documentationp: 1-normalNothing urgentNothing urgents: acceptedAccepted feature / Confirmed bugAccepted feature / Confirmed bug