Coalesce function **Returns** sections

This issue has been tracked since 2023-02-22.

Search Terms



Functions are rendered with two distinct sections, the first with the content of the @returns tag, and the second with the actual TS type.

Screenshot 2023-02-22 at 17 28 37

Suggested Solution

Coalesce the two sections, and render the @returns content on the next line after the type.

This would also be more consistent with the way parameters are rendered (a bulleted list followed by a paragraph with the description).

ilg-ul wrote this answer on 2023-03-05

Any thoughts on this proposal?

If compatibility with older sites is a concern, it can be activated with a configuration option.

Gerrit0 wrote this answer on 2023-03-05

Labeled help wanted to indicate PRs will be gladly accepted, not something that I'm likely to have time to do anytime soon.

ilg-ul wrote this answer on 2023-03-05

Ok, I'll take a look and possibly prepare a PR.

More Details About Repo
Owner Name TypeStrong
Repo Name typedoc
Full Name TypeStrong/typedoc
Language TypeScript
Created Date 2014-05-24
Updated Date 2023-03-19
Star Count 6487
Watcher Count 68
Fork Count 639
Issue Count 48


Issue Title Created Date Updated Date