Preserve newlines in docstring description #271
Merged
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
|
Hi, I have the same issue. @sfisol I'm curious, why not just write |
sfisol
force-pushed
the
preserve-description-newlines
branch
from
d11096f
to
2d2fe1f
Compare
|
You're right @amarjanica, I blindly followed the original pattern :-) Amended. Thanks! |
sfisol
force-pushed
the
preserve-description-newlines
branch
from
2d2fe1f
to
b08e1c0
Compare
wafflespeanut
approved these changes
Dec 3, 2020
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!
This small change adds "\n" at the end of every line in description gathered from docstring. This allows to display markdown when using swagger.
Whereas this works perfectly for me, I'm not sure about other use-cases. For example if in future paperclip will support YAML format then this could potentially break something.
If you have any advice let me know and I'll try to amend this.