Add example parsing from comments for adding to the spec examples. En… #7
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
…ables better examples in UI
… example content and descriptions within comment sections of a schema. In details, the changes cover: - Adding logic to incorporate the example and description into the schema. This happens when parsing comments associated with fields within a type. - Adjusting `parseDescriptionAndExampleFromComments` function: whenever an "Example:" is located, the function trims spaces and quotes, and strips the example from the description. When no example is found, the function returns the unaltered description. - Within `parseExample` function, we've added conversion logic to turn the string comment into the respective type of the schema field. This only occurs when the schemaType is specified as "string". These changes were deemed necessary to properly process examples and adhere to relevant specifications, thus improving our schema's quality and usability.
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.
…ables better examples in UI