search

jwg4 / flask-selfdoc

Flask-selfdoc automatically creates an online documentation for your flask application.
MIT License
18 stars 4 forks source link

Format output correctly #31

Closed kjohnsen closed 6 years ago

kjohnsen commented 6 years ago

It seems docstrings get parsed into HTML and get printed that way, as noted in the flask-autodoc issue.

For example:

"""This multline
docstring"""

gets printed like this: This multiline\<br>docstring

jwg4 commented 6 years ago

Thanks for the report! I will try and figure this one out - it seems like it used to work in older versions of flask. We don't want to remove formatting in those versions by fixing it for later versions.

jwg4 commented 6 years ago

@kjohnsen I am looking into this one. can you let me know the Python version and the Flask version that you experienced this with. If possible, post your pip freeze so that I can see the versions of the individual Flask dependencies.

jwg4 commented 6 years ago

Fixed by #41

kjohnsen commented 6 years ago

Thank you for fixing despite my slow response!

jwg4 commented 6 years ago

@kjohnsen No problem, it was a simple bug with a fix on stack overflow: https://stackoverflow.com/a/14126505/1737957

This isn't released yet but I will try and have a new version soon. Or you can install from the master branch.