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.

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

docs: document @throws parameter in API docs #2050

Merged
merged 5 commits into from
Apr 16, 2023

Conversation

matthewmayer
Copy link
Contributor

@matthewmayer matthewmayer commented Apr 15, 2023

fix #2048

Example:

Screenshot 2023-04-15 at 17 08 06

@matthewmayer matthewmayer requested a review from a team April 15, 2023 10:18
@matthewmayer matthewmayer requested a review from a team as a code owner April 15, 2023 10:18
@codecov
Copy link

codecov bot commented Apr 15, 2023

Codecov Report

Merging #2050 (850b27d) into next (bc58f22) will decrease coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #2050      +/-   ##
==========================================
- Coverage   99.61%   99.61%   -0.01%     
==========================================
  Files        2535     2535              
  Lines      241583   241583              
  Branches     1285     1283       -2     
==========================================
- Hits       240656   240648       -8     
- Misses        900      908       +8     
  Partials       27       27              

see 1 file with indirect coverage changes

Copy link
Member

@ST-DDT ST-DDT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice.

scripts/apidoc/typedoc.ts Outdated Show resolved Hide resolved
scripts/apidoc/signature.ts Show resolved Hide resolved
@Shinigami92 Shinigami92 added the c: docs Improvements or additions to documentation label Apr 15, 2023
@ST-DDT ST-DDT added p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug labels Apr 15, 2023
matthewmayer and others added 2 commits April 15, 2023 17:54
Co-authored-by: Shinigami <chrissi92@hotmail.de>
scripts/apidoc/typedoc.ts Outdated Show resolved Hide resolved
Co-authored-by: ST-DDT <ST-DDT@gmx.de>
@ST-DDT ST-DDT requested review from a team April 16, 2023 10:44
@ST-DDT ST-DDT merged commit ec4d428 into faker-js:next Apr 16, 2023
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Document @throws in api docs
4 participants