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

docs: add test for api docs generation #574

Merged
merged 9 commits into from
Mar 7, 2022
Merged

docs: add test for api docs generation #574

merged 9 commits into from
Mar 7, 2022

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Feb 26, 2022

This PR adds a test that ensures, that the api docs generation does not break (at least on the data side).

Note:

To be merged after #564

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation c: test labels Feb 26, 2022
@ST-DDT ST-DDT requested a review from a team as a code owner February 26, 2022 17:01
@ST-DDT ST-DDT self-assigned this Feb 26, 2022
@codecov
Copy link

codecov bot commented Feb 26, 2022 •
edited
Loading

Codecov Report

Merging #574 (55f74f1) into main (c115056) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #574      +/-   ##
==========================================
- Coverage   99.34%   99.34%   -0.01%     
==========================================
  Files        1920     1920              
  Lines      176444   176444              
  Branches      906      904       -2     
==========================================
- Hits       175289   175287       -2     
- Misses       1099     1101       +2     
  Partials       56       56
Impacted Files Coverage Δ
src/vendor/unique.ts 95.96% <0.00%> (-1.62%) ⬇️

Base automatically changed from docs/generate-docs-for-injected-methods to main March 1, 2022 18:55
@Shinigami92 Shinigami92 added the needs rebase There is a merge conflict label Mar 1, 2022
@ST-DDT ST-DDT force-pushed the docs/add-api-docs-generation-tests branch from d68a00d to eb7df4b Compare March 1, 2022 21:45
@ST-DDT ST-DDT removed the needs rebase There is a merge conflict label Mar 1, 2022
@ST-DDT
Copy link
Member Author

ST-DDT commented Mar 1, 2022

Updated

Shinigami92
Shinigami92 previously approved these changes Mar 2, 2022
View reviewed changes
@ST-DDT ST-DDT requested a review from a team March 2, 2022 08:38
@ST-DDT ST-DDT mentioned this pull request Mar 2, 2022
Closed
@ST-DDT ST-DDT requested review from griest024 and a team March 3, 2022 00:29
@ST-DDT ST-DDT requested a review from Shinigami92 March 3, 2022 08:13
@ST-DDT ST-DDT merged commit c99160f into main Mar 7, 2022
@ST-DDT ST-DDT deleted the docs/add-api-docs-generation-tests branch March 7, 2022 19:47
demipel8 pushed a commit to demipel8/faker that referenced this pull request Mar 11, 2022
@ST-DDT @demipel8
docs: add test for api docs generation (faker-js#574)
0e48844
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Shinigami92 Shinigami92 Shinigami92 approved these changes

@prisis prisis prisis approved these changes

@griest024 griest024 Awaiting requested review from griest024

Assignees

@ST-DDT ST-DDT

Labels
c: docs Improvements or additions to documentation c: test
Projects
None yet
Milestone
v6.0 - Ensure Project Foundation
Development

Successfully merging this pull request may close these issues.
4 participants
@ST-DDT @prisis @griest024 @Shinigami92