Add config for optional use of response return comments as response descriptions - #1254
Open
yugarinn wants to merge 3 commits into
Open
Add config for optional use of response return comments as response descriptions#1254yugarinn wants to merge 3 commits into
yugarinn wants to merge 3 commits into
Conversation
Member
|
@yugarinn Thanks for the PR. I will consider making this a default behavior and parse only status and body annotation. I just need to think a bit on it before merging the PR. |
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
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.
Hello there! First of all, thank you for maintaining this package :)
I am opening this PR to cover for a case that bit me this morning. I needed to temporarily comment out a line to push a hotfix into production, and our pipeline kept regenerating the API docs with the comment:
This was the (bad, I know) hotfix:
And this is what ended up being generated in our API documentation:
I ended up moving the commet way above to avoid this, but it would have been great to have the option to ignore it entirely... thus this PR.
Please let me know if this approach seems correct to you, whether or not it is properly tested, or even if you want this at all! This could also be generalized to enable/disable other features. Another approach could be just ignoring comments that are separated from the
returnstatement by a newline, but I digress.