Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document @throws in api docs #2048

Closed
ST-DDT opened this issue Apr 14, 2023 · 0 comments · Fixed by #2050
Closed

Document @throws in api docs #2048

ST-DDT opened this issue Apr 14, 2023 · 0 comments · Fixed by #2050
Assignees
@matthewmayer
Labels
c: docs Improvements or additions to documentation c: feature Request for new feature p: 1-normal Nothing urgent
Milestone
v8.x

Comments

@ST-DDT
Copy link
Member

ST-DDT commented Apr 14, 2023

Clear and concise description of the problem

Currently some methods have jsdocs @throws tags. However these don't show up on the api docs page.

Suggested solution

Add them to the api docs generation.

Alternative

Don't show them.

Additional context

Found in: #2045 (comment)
@ST-DDT ST-DDT added c: docs Improvements or additions to documentation c: feature Request for new feature p: 1-normal Nothing urgent labels Apr 14, 2023
@ST-DDT ST-DDT mentioned this issue Apr 14, 2023
Merged
@ST-DDT ST-DDT moved this to Todo in Faker Roadmap Apr 14, 2023
@matthewmayer matthewmayer mentioned this issue Apr 15, 2023
Merged
@ST-DDT ST-DDT moved this from Todo to In Progress in Faker Roadmap Apr 15, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in Faker Roadmap Apr 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@matthewmayer matthewmayer

Labels
c: docs Improvements or additions to documentation c: feature Request for new feature p: 1-normal Nothing urgent
Projects
No open projects
Faker Roadmap
Status: Done
Milestone
v8.x
Development

Successfully merging a pull request may close this issue.

docs: document @throws parameter in API docs matthewmayer/faker
2 participants
@matthewmayer @ST-DDT