Add an option to fallback to comments if a description is not provided #459
Conversation
This file contains hidden or 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
vojtapol
requested changes
Dec 8, 2020
rideliner
force-pushed
the
feature/comment-documentation
branch
from
9235282 to
1a613e0
Compare
|
@rideliner please resolve to conflict. We've migrated all tests to kotlin so you can leave it out. I can recreate your test after that. |
The default behavior, to match existing behavior, is to fallback to comments. Setting `commentsAsFallbackDescription` to false in the `SchemaParserOptions` will result in comments not being used when a description is not provided.
rideliner
force-pushed
the
feature/comment-documentation
branch
from
1a613e0 to
1235712
Compare
florensie
reviewed
Apr 23, 2021
| when { | ||
| node.description != null -> node.description.content | ||
| !options.useCommentsForDescriptions -> null | ||
| node.comments.isNullOrEmpty() -> null |
There was a problem hiding this comment.
These two conditions both return null so you could just combine them into one.
vojtapol
approved these changes
Aug 13, 2021
|
Closing this since we're unable to push/merge it as it is. Opened #564 with the same commits. |
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.
Checklist
Description
The existing behavior is to always fallback to comments from the schema. This change would add a configuration option to
SchemaParserOptionsthat would make it possible to ignore comments and exclusively use descriptions from the schema.For example:
This schema with the current behavior would result in the description being
Copyright 2020\nAuthors: ....With the
commentsAsFallbackDescriptionoption set as false, the description will be null.