Have a way to disable max-height on comments

[kazemicode]

PR #180044 introduced a max-height on comments, which goes against my team's use case when using the CodeTour extension. Since our tours have animated GIFs that support our hands-on coding labs, the reduced max-height makes it impossible for a user to see entire images in the comment frame at once, which imposes a negative learner experience. (See: https://www.youtube.com/watch?v=h0F8_-Te8p4 for comparison across versions).

Proposed feature is to allow a user to set a max-height rather than imposing a max-height.

[gjsjohnmurray]

I also think it should be settable through the API. My original commit on the PR has a comment exchange with @alexr00 about this at the place where I originally hardwired it.

[alexr00]

Generally we try not to add API unless we see a clear case for having it. At the time @gjsjohnmurray suggested the max height I wasn't aware of a use case that would require a comment peek view to have a larger size.

@kazemicode your case makes sense, and makes the case for having API for this. I would make this API rather than user configurable.

[kazemicode]

Yes, making the max-height configurable via the API makes perfect sense, since any extension can be configured with that functionality to set a max-height attribute that makes sense for the use case.

@alexr00 Would the default behavior go back to expanding the height with the content?

[alexr00]

@kazemicode I'm not sure yet which would be default. I will discuss with our UX folks and see what they prefer.

[kazemicode]

@alexr00 My humble preference would be to adopt the old behavior as the default. Though the CodeTour extension is open source, it’s only seen one update in the past year. My team has a stale PR from 2021 on the CodeTour repo that was never commented on, so I’m afraid that even if we opened a PR with a fix for the max-height problem, it might not ever get accepted and merged. On the other hand, my team has been discussing forking CodeTour so that we can control the addition of new functionality and bug fixes.

[alexr00]

There wasn't enough interest in adding API for this, so I added the user setting "comments.maxHeight".

[kazemicode]

@alexr00 thanks! Is comments.maxHeight a boolean? If so, is the default true (maintaining the maxHeight as 20em by default) or false (no maxHeight defined?

[alexr00]

It is a boolean and the default is true, meaning the max height of a comment will be 20em.

[VSCodeTriageBot]

This bug has been fixed in the latest release of VS Code Insiders!

@kazemicode, you can help us out by commenting /verified if things are now working as expected.

If things still don't seem right, please ensure you're on version b4952d1 of Insiders (today's or later - you can use Help: About in the command palette to check), and leave a comment letting us know what isn't working as expected.

Happy Coding!

[kazemicode]

/verified

Works great! Thanks!

[alexr00]

Thanks for verifying!