You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
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.
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:
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
boolean
Similarly to
parametersFormat
, a configuration option can be used to control the rendering.The text was updated successfully, but these errors were encountered: