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

Would rendering the Returns section as a table look better? #712

Closed
ilg-ul opened this issue Oct 31, 2024 · 2 comments
Closed

Would rendering the Returns section as a table look better? #712

ilg-ul opened this issue Oct 31, 2024 · 2 comments

Comments

@ilg-ul
Copy link

ilg-ul commented Oct 31, 2024

What package is the feature request related to?

typedoc-plugin-markdown

Background

Currently the parameters can be rendered as a table, and I think they look better than the default sequence of lines.

The Returns section is simpler, a type and possibly a description:

Screenshot 2024-10-31 at 12 54 24

Proposed solution

I wonder if rendering it also like a small table, with two columns (Type & Description) would not make it look slightly better.

Something like this:

Returns

Type Description
boolean True if the current log level is equal to the given level or higher.

Similarly to parametersFormat, a configuration option can be used to control the rendering.

@ilg-ul ilg-ul changed the title Would rendering the Return section as a table look better? Would rendering the Returns section as a table look better? Oct 31, 2024
@tgreyuk
Copy link
Member

tgreyuk commented Nov 1, 2024

Thanks - yes potentially could introduce a new option for this. I will review it.

@tgreyuk
Copy link
Member

tgreyuk commented Dec 19, 2024

Tables could work well for simple primitive types, but return types might be complex and not suitable for table layout so probably won't be implementing this. Thanks for suggestion though if I come up with a good solution will revisit.

@tgreyuk tgreyuk closed this as completed Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants