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: check api references #2024

Merged
merged 13 commits into from Apr 20, 2023
Merged

docs: check api references #2024

merged 13 commits into from Apr 20, 2023

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Apr 4, 2023

Implements #1974

This PR adds tests that ensureing all links in descriptions and references in @see tags point to existing api endpoints.

The tests found 1 broken reference in the image module.

Best reviewed without whitespace changes.

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent c: test labels Apr 4, 2023
@ST-DDT ST-DDT requested review from a team April 4, 2023 20:25
@ST-DDT ST-DDT self-assigned this Apr 4, 2023
@codecov
Copy link

codecov bot commented Apr 4, 2023

Codecov Report

Merging #2024 (4c98165) into next (2098b4d) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #2024   +/-   ##
=======================================
  Coverage   99.62%   99.62%           
=======================================
  Files        2535     2535           
  Lines      242202   242202           
  Branches     1296     1296           
=======================================
+ Hits       241282   241283    +1     
+ Misses        893      892    -1     
  Partials       27       27           
Impacted Files Coverage Δ
src/modules/image/index.ts 100.00% <100.00%> (ø)

... and 2 files with indirect coverage changes

@ST-DDT ST-DDT marked this pull request as ready for review April 4, 2023 20:36
@ST-DDT ST-DDT changed the title docs: check references docs: check api references Apr 4, 2023
matthewmayer
matthewmayer previously approved these changes Apr 5, 2023
@ST-DDT ST-DDT requested a review from a team April 5, 2023 05:47
scripts/apidoc/markdown.ts Show resolved Hide resolved
@Shinigami92 Shinigami92 merged commit a001ac5 into next Apr 20, 2023
17 checks passed
@Shinigami92 Shinigami92 deleted the docs/check-references branch April 20, 2023 18:22
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 c: test p: 1-normal Nothing urgent
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add tests ensuring @see links and other faker api references work as expected
4 participants