Skip to content

Dartdoc tooltips are not rendered as expected #41

Closed

Description

@jacehensley-wf

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.

Activity

  1. DanTup commented on Aug 6, 2016

    @DanTup
    Member

    @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!

  2. DanTup commented on Aug 6, 2016

    @DanTup
    Member

    See #26 for details/screenshot.

  3. jacehensley-wf commented on Aug 6, 2016

    @jacehensley-wf
    ContributorAuthor

    Awesome!

  4. DanTup commented on Aug 6, 2016

    @DanTup
    Member

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

  5. jacehensley-wf commented on Aug 8, 2016

    @jacehensley-wf
    ContributorAuthor

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

    imge

  6. reopened this on Aug 8, 2016
  7. added this to the v1.0 milestone on Aug 8, 2016
  8. changed the title [-]Improve Tooltip Formatting[/-] [+]Newlines and code samples are stripped from dartdocs in tooltips[/+] on Aug 8, 2016
  9. DanTup commented on Aug 8, 2016

    @DanTup
    Member

    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.

  10. DanTup commented on Aug 9, 2016

    @DanTup
    Member

    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.

  11. DanTup commented on Aug 11, 2016

    @DanTup
    Member

    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 :-)

  12. 29 remaining items

  13. DanTup commented on Aug 31, 2016

    @DanTup
    Member

    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
  14. modified the milestones: , on Aug 31, 2016
  15. DanTup commented on Sep 8, 2016

    @DanTup
    Member

    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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions