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

Exception names with backticks are incorrectly displayed #13593

Closed
psfinaki opened this issue Jul 29, 2022 · 5 comments · Fixed by #13552
Closed

Exception names with backticks are incorrectly displayed #13593

psfinaki opened this issue Jul 29, 2022 · 5 comments · Fixed by #13552
Assignees
Labels
Milestone

Comments

@psfinaki
Copy link
Member

Consider the following code:

exception SomeError of ``thing with space``: string

The tooltip is displayed like this:
image
It looks strange, the backticks should be preserved in the display name.

@baronfel
Copy link
Member

I'd push back on that - I think that tooltip formatting looks perfectly fine as is. Double backticks in the tooltip would be more visual noise (but it would align with the code written, I'll grant you that).

@psfinaki
Copy link
Member Author

@dsyme?

@vzarytovskii
Copy link
Member

I'd push back on that - I think that tooltip formatting looks perfectly fine as is. Double backticks in the tooltip would be more visual noise (but it would align with the code written, I'll grant you that).

Yeah, i think as long as it's visually distinguishable (colour, and maybe some additional font styling/formatting, for visually impaired) should he good enough. I think backticks will bring heaviness to the tooltip.

@baronfel
Copy link
Member

baronfel commented Jul 29, 2022

Also from a selfish perspective if the backticks are added to the text portions of the TaggedTexts then FsAutoComplete will have to do extra work to detect and remove them for tooltips, since backticks are valid markdown characters for styling purposes.

@dsyme
Copy link
Contributor

dsyme commented Jul 31, 2022

The main thing here is consistency - we should do whatever we do for values, functions, methods, types, union cases, record fields.

My understanding from the deep code review we did is that we add back ticks for tool tips in these cases, so we should make this case consistent and then deal with alternative choices systematically in a separate issue

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

Successfully merging a pull request may close this issue.

4 participants