Community
Participate
Working Groups
Created attachment 280341 [details] Documentation hovers in lsp4e When styling delimiters such as bold (**) or italic (_) are present inside words (e.g. something_like_this), most Markdown implementations ignore them; this leads to improper rendering otherwise. The LSP4E project relies on Wikitext to display its hovers and variable names often contain underscores, which makes the documentation hard to read. I have attached an example to showcase this issue.
@Pierre Yves: is this a bug you'd be interested to fix?
(In reply to Mickael Istria from comment #1) > @Pierre Yves: is this a bug you'd be interested to fix? I've got a few things on my plate at the moment, but may be able to take a look at some point. No promises though. ;)
Okay, I gave it a go and I've got an implementation working locally! I will wait for Bug 509033 to be merged before submitting a patch: as both modifications touch very similar portions of code, this may be confusing for the reviewer and cause a conflict on rebase.
IMO, it's still better to submit a patch for this from now on rather than waiting and taking the risk of not being available to work on it later ;)
New Gerrit change created: https://git.eclipse.org/r/153093
(In reply to Mickael Istria from comment #4) > IMO, it's still better to submit a patch for this from now on rather than > waiting and taking the risk of not being available to work on it later ;) Fair, I've submitted the patch. :)
@Leo: any chance this patch and the other one from Pierre-Yves can be merged soon, so they get a good chance of being in 2019-09?
(In reply to Mickael Istria from comment #7) > @Leo: any chance this patch and the other one from Pierre-Yves can be merged > soon, so they get a good chance of being in 2019-09? Mickael probably meant 2019-12, not 2019-09. I do agree though, this would benefit the Markdown editor/viewer shipped with every Eclipse package, but also downstream projects such as LSP4E/TM4E and the projects that depend on them. ;)
Gerrit change https://git.eclipse.org/r/153093 was merged to [master]. Commit: http://git.eclipse.org/c/mylyn/org.eclipse.mylyn.docs.git/commit/?id=4877cb35eb973c50ca3c123e34d3999ab6ab0c1f
(In reply to Pierre-Yves B. from comment #8) > (In reply to Mickael Istria from comment #7) > > @Leo: any chance this patch and the other one from Pierre-Yves can be merged > > soon, so they get a good chance of being in 2019-09? > > Mickael probably meant 2019-12, not 2019-09. I do agree though, this would > benefit the Markdown editor/viewer shipped with every Eclipse package, but > also downstream projects such as LSP4E/TM4E and the projects that depend on > them. ;) I merged this patch and added comments to the other. I believe that this defect and the missing strikethrough arise from the fact that our Markdown implementation is true to the Daring Fireball spec https://daringfireball.net/projects/markdown/syntax and doesn't include most of the Github-flavoured Markdown or CommonMark additions. We have another CommonMark implementation in incubation, but it hasn't been developed in a long time and I'm not sure how far it got. Since this defect and the request for strikethrough are pretty common additions to Markdown, I'm happy to take these two patches with the understanding that we're not looking to add the full CommonMark feature set!
Thanks for the insight and the review Leo! By the way, this project doesn't seem to be importable via Oomph. It would be a great thing to setup for contributors. When trying to manually import it in the latest nightly Eclipse SDK, I ended up with thousands of errors all around the project and didn't get very far with attempting to fix them. Luckily, the few files I had to modify were error-free and the associated unit tests could be run.
