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

Should .description be shown in “Description” column #205

Closed
wooorm opened this issue Mar 16, 2017 · 4 comments
Closed

Should .description be shown in “Description” column #205

wooorm opened this issue Mar 16, 2017 · 4 comments
Labels

Comments

@wooorm
Copy link

wooorm commented Mar 16, 2017

Hi! 👋

upgrading-to-standard-linter-v2.md states the following:

html is no longer allowed, similar functionality is available as description which is either a string or a function (Promise) returning a string which is then rendered as Markdown.

Maybe I’ve missed something, but when upgrading I thought I could use .description for rich (non plain-text) message reasons. Especially as there’s now a column, “Description”, which apparently does not use .description on messages, to my surprise :)

TLDR

Possible bug: should description be used in linter-ui-default
Question: if not, where does it end up?

@steelbrain
Copy link
Owner

steelbrain commented Mar 16, 2017

Description is actually used in linter-ui-default, you have to expand it on the tooltips, we don't show it on the linter panel because description is by nature YUGE and panel doesn't have as much space.

You can click the carot on the left most of the tooltip or you can bind linter-ui-default:expand-tooltip command to a key of your preference

Edit: You can see description being used at the end of the Linter v2 Sneak Peek video

@wooorm
Copy link
Author

wooorm commented Mar 16, 2017

Oh okay, sorry, I missed that. I thought that, due to the suggestion of using description instead of html they’d show up in the same places.

Okay, one final question! Is it somehow possible to use markup/markdown in excerpt?

@steelbrain
Copy link
Owner

There's currently no way to add markdown/markup to excerpt, the reason is that we want it to be text and consistent text, for example linter-eslint will change from the ribbon style stuff into simple rule: message. It previously used to add a link into the message html, but now we've added a separate url property for that! :)

@wooorm
Copy link
Author

wooorm commented Mar 17, 2017

Alright, thanks a lot for your help!

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