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

CompletionItem.documentation should be plain text #215

Closed
aeschli opened this issue May 17, 2017 · 4 comments
Closed

CompletionItem.documentation should be plain text #215

aeschli opened this issue May 17, 2017 · 4 comments

Comments

@aeschli
Copy link
Collaborator

aeschli commented May 17, 2017

v0.4.0

  • in VSCode, create a sample project and do code assist on
package com.aeschli.testapp;

public class TestHelper {
    public static boolean compare(String a, String b) {
        return a.|
    }
}

This shows code assist proposals. Looking at the issue descriptions, they are not correctly rendered.
image

Unfortunately, CompletionItem.documentation (and details) only support plain text.
On our side, the request to support rich text is microsoft/vscode#11877

@fbricon
Copy link
Collaborator

fbricon commented May 24, 2017

This is what I get when converting Html Javadoc to Eclipse Html JavaDoc to plain text.

screen shot 2017-05-24 at 12 32 50 pm

Cheap to implement and while it's not absolutely perfect, it might be sufficient.

@gorkem @aeschli WDYT?

Edit: another imperfect exemple
screen shot 2017-05-24 at 12 44 52 pm

@fbricon fbricon changed the title CompletionItem.description should be plain text CompletionItem.documentation should be plain text May 24, 2017
@fbricon
Copy link
Collaborator

fbricon commented May 24, 2017

basically, rendering nested lists from html to plaintext using that method sucks

fbricon added a commit to fbricon/eclipse.jdt.ls that referenced this issue May 26, 2017
Fixes redhat-developer/vscode-java#215

Signed-off-by: Fred Bricon <fbricon@gmail.com>
fbricon added a commit to fbricon/eclipse.jdt.ls that referenced this issue May 26, 2017
Fixes redhat-developer/vscode-java#215

Signed-off-by: Fred Bricon <fbricon@gmail.com>
fbricon added a commit to fbricon/eclipse.jdt.ls that referenced this issue May 29, 2017
Fixes redhat-developer/vscode-java#215

Signed-off-by: Fred Bricon <fbricon@gmail.com>
fbricon added a commit to fbricon/eclipse.jdt.ls that referenced this issue May 29, 2017
Fixes redhat-developer/vscode-java#215

Signed-off-by: Fred Bricon <fbricon@gmail.com>
fbricon added a commit to fbricon/eclipse.jdt.ls that referenced this issue May 29, 2017
Fixes redhat-developer/vscode-java#215

Signed-off-by: Fred Bricon <fbricon@gmail.com>
@fbricon fbricon removed this from the End May 2017 milestone May 29, 2017
@fbricon
Copy link
Collaborator

fbricon commented May 29, 2017

removing for current sprint as we're waiting for CQ approval for forking a Jsoup class, on the server side.

fbricon added a commit to fbricon/eclipse.jdt.ls that referenced this issue Jun 19, 2017
Fixes redhat-developer/vscode-java#215

Signed-off-by: Fred Bricon <fbricon@gmail.com>
fbricon added a commit to fbricon/eclipse.jdt.ls that referenced this issue Jul 12, 2017
Fixes redhat-developer/vscode-java#215

Signed-off-by: Fred Bricon <fbricon@gmail.com>
fbricon added a commit to fbricon/eclipse.jdt.ls that referenced this issue Jul 12, 2017
Fixes redhat-developer/vscode-java#215

Signed-off-by: Fred Bricon <fbricon@gmail.com>
fbricon added a commit to fbricon/eclipse.jdt.ls that referenced this issue Jul 12, 2017
Fixes redhat-developer/vscode-java#215

Signed-off-by: Fred Bricon <fbricon@gmail.com>
@fbricon fbricon added this to the End July 2017 milestone Jul 12, 2017
@fbricon
Copy link
Collaborator

fbricon commented Jul 12, 2017

Nested lists with new plain text renderer:
screen shot 2017-07-12 at 4 06 36 pm

fbricon added a commit to eclipse-jdtls/eclipse.jdt.ls that referenced this issue Jul 24, 2017
Fixes redhat-developer/vscode-java#215

Signed-off-by: Fred Bricon <fbricon@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants