Coalesce function **Returns** sections

[ilg-ul]

Search Terms

@returns

Problem

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

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]

Any thoughts on this proposal?

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

[Gerrit0]

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]

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

[ilg-ul]

@futurGH, what do you think about this proposal, does it make any sense?

[futurGH]

Definitely makes sense, I'll see if I can take a stab at it before Gerrit0 gets to it 🙂

[ilg-ul]

Gerrit0 said he will not have time for it anytime soon; I'd be happy to contribute to the project, but I'm not familiar with the internals, and, until I'll get there, your PR will be long ago merged. ;-)

[ilg-ul]

@futurGH explained me that, with the current implementation, the @returns content is part of a composite with all comments, which are all rendered in a loop, and moving the @returns content after the return type would require filtering out in the current loop, and adding a second loop where only @returns is filtered in, which, I agree, is not exactly an elegant solution.

In this case probably the solution would be to parse @returns into a separate property, and render it separately after the return type. Such a change is not trivial (at least for my current skills), and I have no idea what the implications would be, so I let the project maintainers to suggest a solution.

[ilg-ul]

Wow! Looking forward to testing the new release.

Thank you!