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.

Sign up for GitHub

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

Jump to bottom

Lack of formatting in API docs jsdoc `@description` blocks #5887

Open

kuhe opened this issue Mar 13, 2024 · 0 comments

Assignees

Labels

documentation feature-request p2 queued

Contributor

kuhe commented Mar 13, 2024

Describe the issue

On, for example https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-types/TypeAlias/StreamingBlobPayloadInputTypes/, the description is taken from our source code e.g. https://github.com/smithy-lang/smithy-typescript/blob/9fd07df090131109ef630b72cb068867b182753f/packages/types/src/streaming-payload/streaming-blob-payload-input-types.ts#L39

While the source code is formatted, the API docs page has the text in a hard to read blob.

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-types/TypeAlias/StreamingBlobPayloadInputTypes/

https://github.com/smithy-lang/smithy-typescript/blob/9fd07df090131109ef630b72cb068867b182753f/packages/types/src/streaming-payload/streaming-blob-payload-input-types.ts#L39

kuhe added documentation needs-triage p2 feature-request queued and removed needs-triage labels

kuhe self-assigned this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment