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

Dartdoc tooltips are not rendered as expected #41

Closed
jacehensley-wf opened this issue Aug 6, 2016 · 16 comments
Closed

Dartdoc tooltips are not rendered as expected #41

jacehensley-wf opened this issue Aug 6, 2016 · 16 comments

Comments

@jacehensley-wf
Copy link
Contributor

Currently the tooltips stack the doc comment and type, one right after the other. I think it would be easier to read if there was an extra new line between them.

Also It would be nice if the doc comments were formatted via markdown.

@DanTup
Copy link
Member

DanTup commented Aug 6, 2016

@devoncarew recently made a bunch of changes that I think covers this. I might push another build to the marketplace tomorrow if I get some time to finish a few more things.

Thanks for the feedback!

@DanTup
Copy link
Member

DanTup commented Aug 6, 2016

See #26 for details/screenshot.

@jacehensley-wf
Copy link
Contributor Author

Awesome!

@DanTup
Copy link
Member

DanTup commented Aug 6, 2016

I guess this can be considered a dupe then. Do post back if after the update you think it needs more attention!

@DanTup DanTup closed this as completed Aug 6, 2016
@jacehensley-wf
Copy link
Contributor Author

I noticed the update to the tooltip and it is much better I would like it to keep newlines and indentation if possible.

imge

@DanTup DanTup reopened this Aug 8, 2016
@DanTup DanTup added this to the v1.0 milestone Aug 8, 2016
@DanTup DanTup added is bug and removed duplicate labels Aug 8, 2016
@DanTup DanTup changed the title Improve Tooltip Formatting Newlines and code samples are stripped from dartdocs in tooltips Aug 8, 2016
@DanTup
Copy link
Member

DanTup commented Aug 8, 2016

The blank lines are being removed by Code :( I've raised microsoft/vscode#10311 to see what MS say.

The other issue seems to be a weird bug; I've posted in the Analysis Server group to try and understand what's happening.

@DanTup
Copy link
Member

DanTup commented Aug 9, 2016

Microsoft have fixed the blank lines disappearing for the next version (presumably in next insiders release too, but I'm not sure how often that updates, I don't use it yet).

Still awaiting a response from the other issue; it seems like it might be a cache invalidation issue or something in the Dart analysis service so I'm hoping Google can confirm or suggest what I might be doing wrong.

@DanTup
Copy link
Member

DanTup commented Aug 11, 2016

MS have fixed the newlines vanishing and Google have fixed the issues causing tooltips to sometimes show stale data. These will be in future (hopefully next) updates to VS Code and the Dart SDK :-)

@DanTup DanTup closed this as completed Aug 11, 2016
@DanTup DanTup removed this from the v1.0 milestone Aug 11, 2016
@DanTup DanTup added the is bug label Aug 18, 2016
@DanTup
Copy link
Member

DanTup commented Aug 19, 2016

Probably makes sense to keep external issues open until they're dealt with to avoid duplicates being opened (and as a reminder there's something we want to do that is waiting on something else).

Both the issues involved here are fixed but there hasn't been a new Code or SDK release yet.

@DanTup DanTup reopened this Aug 19, 2016
@DanTup DanTup added blocked on dart / flutter Requires a change in Dart or Flutter to progress blocked on vs code / lsp / dap Requires a change in VS Code to progress labels Aug 20, 2016
@DanTup DanTup modified the milestone: v1.0 Aug 22, 2016
@DanTup
Copy link
Member

DanTup commented Aug 28, 2016

We can fix this by sending code blocks as MarkedStrings with the language set, or rewriting the blocks to by fenced with triple-backticks and a language.

@DanTup DanTup changed the title Newlines and code samples are stripped from dartdocs in tooltips Dartdoc tooltips are not rendered as expected Aug 28, 2016
@DanTup
Copy link
Member

DanTup commented Aug 28, 2016

I think the fix for this has introduced far more spacing than intended; I think we're waiting on microsoft/vscode#10311 (comment) again for now.

@DanTup DanTup added external / blocked blocked on vs code / lsp / dap Requires a change in VS Code to progress labels Aug 28, 2016
@DanTup
Copy link
Member

DanTup commented Aug 29, 2016

The issue in code is actually only affecting lists; the other stuff we can already fix (but we'll need to detect code blocks to mark them up as Dart).

@DanTup DanTup added blocked on vs code / lsp / dap Requires a change in VS Code to progress and removed external / blocked blocked on vs code / lsp / dap Requires a change in VS Code to progress labels Aug 29, 2016
@DanTup
Copy link
Member

DanTup commented Aug 31, 2016

This is back with MS; two reasons:

  1. Insiders appears to be dropping newlines again: Blank lines in Hovers are unexpectedly removed microsoft/vscode#10311 (comment)
  2. Request for allowing us to provide a default language for code blocks: Indented code blocks in Hovers should use the correct language for the hover provider microsoft/vscode#11331

@DanTup DanTup modified the milestones: 0.10, 0.11 Aug 31, 2016
@DanTup DanTup added fixed externally: vs code 1.5 and removed blocked on vs code / lsp / dap Requires a change in VS Code to progress labels Sep 3, 2016
@DanTup
Copy link
Member

DanTup commented Sep 8, 2016

Considering this done now. MS intend to ship VS Code 1.5 today and 1.19 SDK is already out.

Hovers are going to get an overhaul soon (in Code, and then Dart Code) so things will improve further in a future version.

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