rust-lang / rust-lang/rust-analyzer

Hover documentation getting cut off

Open
#8,722 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-doc-comments A-hover C-bug S-actionable
Dominant language
Rust
Stars
16.9k
Forks
2.2k
Avg merge
1d 12h
Merged PRs (30d)
72

Description

When A/B'ing rls and rust-analyzer I noticed the following issue:

rls: 1620133819

rust-analyzer: 1620133846

As you can see, the inline doc ouptut of rust-analyzer is cut off right before the [ of [vec!]

Info:

  • rustc 1.53.0-nightly (42816d61e 2021-04-24)
  • rust-analyzer eb741e895 2021-05-03 stable
  • Sublime Text 4

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the hover documentation comparison in the issue using rust-analyzer with Sublime Text 4 and the reported versions. Trace the hover rendering path to find where documentation containing [vec!] is truncated. Done means the full inline documentation is displayed without cutting off the text.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
developer-experience
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.