search

Polymer / atom-plugin

Provides autocompletion, linting, and more for web components.
Other
32 stars 8 forks source link

Autocompletion description text contains a big chunk of markdown #10

Closed TimvdLippe closed 7 years ago

TimvdLippe commented 7 years ago

In the main document, hitting < shows a list of HTML elements to be declared. If you hit the array key down until you are at <paper-button>, the description of the snippet contains a big chunk of markdown. I am not sure if Markdown can even be rendered inside these descriptions, but else I expect a very small description of one or two lines.

rictic commented 7 years ago

+1

Need to do a deeper dive into what formatting we can do inside Autocomplete++'s descriptions.

Looks like they don't support markdown, but we can parse the markdown ourselves and reformat as needed.

TimvdLippe commented 7 years ago

Open issue for markdown support in Autocomplete++: https://github.com/atom/autocomplete-plus/issues/626 An open PR to allow HTML is at https://github.com/atom/autocomplete-plus/pull/733 That would mean that HTML generated from markdown can only be done after that upstream PR is merged :(

rictic commented 7 years ago

I see. Yeah, looks like our best bet for atom at the moment is to extract the first sentence.

TimvdLippe commented 7 years ago

PR is up for Markdown support: https://github.com/atom/autocomplete-plus/pull/790

We somehow to need to figure out how we can force users of this plugin to use that specific version?

rictic commented 7 years ago

Awesome!

So autocomplete-plus is bundled with Atom, so I think it may be enough to specify that we want at least a minimum version of Atom?

But reading your PR, it looks like we could send both description and descriptionMarkdown and it would use the markdown snippet if it understood it, and fall back to the current behavior if it doesn't.

TimvdLippe commented 7 years ago

Yes indeed. So we can just supply them both. Lets wait till the upstream PR is merged and then we can fix it here :)