docs: fix param check #1694
Merged
docs: fix param check #1694
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ST-DDT
added
c: bug
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## next #1694 +/- ##
=======================================
Coverage 99.64% 99.64%
=======================================
Files 2240 2240
Lines 240098 240101 +3
Branches 1068 1068
=======================================
+ Hits 239239 239242 +3
Misses 838 838
Partials 21 21
|
Shinigami92
approved these changes
Dec 27, 2022
xDivisionByZerox
approved these changes
Dec 29, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #1685
scripts/apidoc/signature.ts#1685I changed the script so it no longer fails for missing nested descriptions.
Instead, I added a test that checks that the generated api-docs have proper descriptions for all params.