-
-
Notifications
You must be signed in to change notification settings - Fork 419
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docgen] docstrings not rendered correctly #2130
Comments
I dont think you are fully correct @mfelsche for example: This is rendered fine: https://stdlib.ponylang.org/files-FileMode/ so something else is going on |
O i c what you mean @mfelsche. Right. That makes sense. |
This is an interesting one... |
I dont think this used to happen. Because custodian is one of the classes I tested a lot of changes on so, at some point something changed that broke this. |
The bug is in https://github.com/ponylang/ponyc/blob/master/src/libponyc/ast/lexer.c#L567 |
class/actor/method docstrings is not properly rendered as markdown.
My best guess is that the indentation is not removed and so iterally everything between opening and closing
"""
is considered as docstring.This happens for all docstrings that contain an empty line, it seems.
Examples:
The docstring for Flags appear as indented in the markdown but this is not visible in the generated html. The docstring for Flag is not indented in the markdown.
The text was updated successfully, but these errors were encountered: