Skip to content
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

Closed
mfelsche opened this issue Aug 3, 2017 · 5 comments · Fixed by #2131
Closed

[docgen] docstrings not rendered correctly #2130

mfelsche opened this issue Aug 3, 2017 · 5 comments · Fixed by #2131

Comments

@mfelsche
Copy link
Contributor

mfelsche commented Aug 3, 2017

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.

@SeanTAllen
Copy link
Member

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

@SeanTAllen
Copy link
Member

O i c what you mean @mfelsche.

Right.

That makes sense.

@SeanTAllen
Copy link
Member

This is an interesting one...

@SeanTAllen
Copy link
Member

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.

@mfelsche
Copy link
Contributor Author

mfelsche commented Aug 4, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants