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

Improve generated docs #186

Closed
kggilmer opened this issue Mar 4, 2021 · 3 comments
Closed

Improve generated docs #186

kggilmer opened this issue Mar 4, 2021 · 3 comments
Labels
chore duplicate This issue or pull request already exists good-first-task Good for newcomers

Comments

@kggilmer
Copy link
Contributor

kggilmer commented Mar 4, 2021

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:

 /**
     * <p>Lists the clients that have been created for the specified user pool.</p>
     */
    suspend fun listUserPoolClients(input: ListUserPoolClientsRequest): ListUserPoolClientsResponse

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

@kggilmer
Copy link
Contributor Author

kggilmer commented Mar 4, 2021

(Aaron Todd - Jan 6, 2021)

@aajtodd
Copy link
Contributor

aajtodd commented Mar 17, 2021

this might be a duplicate of #136 at this point

@aajtodd aajtodd added the duplicate This issue or pull request already exists label Jun 9, 2021
@aajtodd
Copy link
Contributor

aajtodd commented Jun 9, 2021

closing as duplicate

@aajtodd aajtodd closed this as completed Jun 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore duplicate This issue or pull request already exists good-first-task Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants