-
Notifications
You must be signed in to change notification settings - Fork 26
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
Improve generated docs #186
Labels
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Documentation is generated for the model but we are currently leaving in any inline HTML markup.
We should consider stripping this or converting to markdown.
UPDATE: 2/25/2021 - some of this may have been handled in PR 61. We should still look into our generated documentation to figure out what improvements could be made. We should also process the HTML rather than just strip it (e.g. turn lists into markdown lists, links into proper links, perhaps even attempt to do inter doc linking).
I noticed in Intellij at least that the type hints don't show the documentation when the HTML tags are present:
We should also probably generate documentation on the DslBuidler, FluentBuilder, and the immutable type itself when generating structures. Right now we only generate it on the immutable type but this doesn't help customers when building an object figure out what those properties are.
internal id: 176378957
The text was updated successfully, but these errors were encountered: