Add support for JSDoc descriptions from object types #3
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
daniel-chambers
force-pushed
the
descriptions
branch
from
7e2cdd4 to
bceefb6
Compare
sordina
approved these changes
Jan 29, 2024
There was a problem hiding this comment.
Looks good @daniel-chambers I was slightly confused why some of the test output keys were now quoted but I guess it was just updating with the new output, and it doesn't make any difference anyway.
| @@ -5,6 +5,7 @@ This changelog documents the changes between release versions. | |||
| Changes to be included in the next upcoming release | |||
|
|
|||
| - Add support for parallel execution of readonly functions ([#2](https://github.com/hasura/ndc-nodejs-lambda/pull/2)) | |||
| - Add support for JSDoc descriptions from object types ([#3](https://github.com/hasura/ndc-nodejs-lambda/pull/3)) | |||
Comment on lines
+199
to
+203
| Descriptions are collected for: | ||
| * Functions | ||
| * Function parameters | ||
| * Types | ||
| * Type properties |
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.
Note: This PR is stacked on #2 and will be rebased on main when that PR merges.Done.JIRA: NDC-345
This PR adds support for JSDoc descriptions on object types. We currently support picking up descriptions from function definitions and function arguments, but object types and their properties were missed.
For example, we now support:
Unit tests have been added to check gathering of descriptions from functions and from types.