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

Superfluous newlines in table column descriptions #591

Closed
chris-pieri opened this issue Apr 17, 2024 · 6 comments
Closed

Superfluous newlines in table column descriptions #591

chris-pieri opened this issue Apr 17, 2024 · 6 comments
Labels

Comments

@chris-pieri
Copy link

Hello 👋,

I'm using version: 4.0.0-next.55

I am able to render a table for my interface with the following headers Property, Type, Description.

Currently any property with a Default Value gets added on a new line in the description cell. Is it possible to instead add a Default Value header in between Type and Description?

@tgreyuk
Copy link
Member

tgreyuk commented Apr 19, 2024

Defaults values now exposed in table. Both of the following will work in 4.0.0-next.56:

prop = 'propValue'
/**
 * @defaultValue 'propValue'
 * /
prop: string

@tgreyuk tgreyuk added the next Fix available in the '@next' release label Apr 19, 2024
@chris-pieri
Copy link
Author

Thanks for making the update it's working now!

One nit picky thing, it looks like the <br /> tags are still being added in the description cell for the rows that have a default value (tested on version 4.0.0-next.60).

Sorry, I tried uploading images but my work laptop won't allow it 🤦‍♂️.

@tgreyuk
Copy link
Member

tgreyuk commented May 3, 2024

@chris-pieri Thanks. Just to confirm you mean the extra space below the description?

Screenshot 2024-05-03 at 17 25 20

@tgreyuk tgreyuk added bug and removed next Fix available in the '@next' release labels May 3, 2024
@chris-pieri
Copy link
Author

Yes exactly, thanks

@tgreyuk tgreyuk changed the title Customize Headers in Property Table Superfluous newlines in table column descriptions May 4, 2024
@tgreyuk
Copy link
Member

tgreyuk commented May 6, 2024

fixed in typedoc-plugin-markdown@4.0.1

@tgreyuk tgreyuk closed this as completed May 6, 2024
@chris-pieri
Copy link
Author

Thank you looks great ! Congrats on 4.0 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants