Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

Set descriptionMarkdown property for Atom auto-complete suggestion #69

Merged
merged 1 commit into from
Aug 1, 2017

Conversation

BoykoAlex
Copy link
Contributor

@BoykoAlex BoykoAlex commented Jul 21, 2017

AutoComplete+ suggestion model has descriptionMarkdown property for Markdown format proposal documentation. (Think it's safe for plain text as well)
Although LS protocol doesn't specify that documentation is MarkedString VSCode language client accepts Markdown format documentation, so does Eclipse client. Looks like it's easy to add support for this in Atom too.

@damieng
Copy link
Contributor

damieng commented Jul 21, 2017

I wonder if we should have some detection logic that tries to figure out if it's markdown or not and then sets the appropriate field.

I'm assuming right now that with that change it always interprets this as markdown because that property is always set.

@BoykoAlex
Copy link
Contributor Author

Plain text can be considered as markdown and markdown can be considered as plain text. Think the check that we could put in could only rely on some likelyhood of text being Markdown... Perhaps we could expect [comment]: <> (Markdown) a markdown comment at start of the doc string to interpret it as markdown... What do you think?

@BoykoAlex
Copy link
Contributor Author

Think it's best to wait for the protocol to have something that reliably tells us whether documentation is Markdown or anything else. (microsoft/language-server-protocol#111)
Don't think it'll be such a bad thing if plain text will be rendered as markdown though, but there might be regressions.

@damieng
Copy link
Contributor

damieng commented Jul 24, 2017

I think you're right - until the protocol allows specification we shouldn't use both.

There's a chance ASCII will be misinterpreted if we make this the default. We either need a config switch or an easy code-path to change the behavior.

@damieng
Copy link
Contributor

damieng commented Aug 1, 2017

Going to merge this and then change it to be parameter driven so package authors can set a flag if they want markdown formatted descriptions. Thanks!

@damieng damieng merged commit 63afe18 into atom:master Aug 1, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants