[QUESTION] Why are description strings joined with double newlines?

[dfkki123508]

For me it causes problems when trying to render markdown, e.g.

@validate()
def fun():
    """summary

    | One | Two | Three |
    |-----|-----|-------|
    | a   | b   | c     |

    | One | Two | Three |

    |-----|-----|-------|

    | a   | b   | c     |

    """

results in the spec as:

"description": "| One | Two | Three | |-----|-----|-------| | a | b | c |\n\n| One | Two | Three |\n\n|-----|-----|-------|\n\n| a | b | c |"

I did not find a possiblity to render single newlines. Can you help me?
PS: I am referring to this line:

spectree/spectree/utils.py

Line 46 in f04c9b7

description = "\n\n".join(docstring_parts[1:])

Thanks!

[kemingy]

Hi, @dfkki123508 thanks for your feedback.

I think the parse_comments function doesn't support single newlines. There are two parts.

spectree/spectree/utils.py

Line 41 in f04c9b7

docstring_parts[i] = docstring_parts[i].replace("\n", " ")

This line ensures that users can write long descriptions in multiple lines.

spectree/spectree/utils.py

Line 46 in f04c9b7

description = "\n\n".join(docstring_parts[1:])

This line ensures that different sections (split by \n\n) will have a clear separation in the document.

I admit that we didn't cover your use case. I'll try to find a better way to handle this.

[dfkki123508]

Thanks for the quick answer! I think a workaround is probably to use html tags, but have to try it out :)

[kemingy]

Thanks for the quick answer! I think a workaround is probably to use html tags, but have to try it out :)

HTML should work. BTW, for this kind of Markdown flavor table, I guess I can only provide a <code><\code> HTML tag. I guess swagger/redoc won't render it to the real HTML table.

So, maybe using the HTML code directly will be better for your use case?