rust-lang / rust-lang/rust-analyzer

Weird docs for trait aliases

Open
#18,632 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-bug
Dominant language
Rust
Stars
16.9k
Forks
2.2k
Avg merge
1d 12h
Merged PRs (30d)
72

Description

rust-analyzer version: rust-analyzer version: 0.3.2204-standalone

rustc version: rustc 1.84.0-nightly (5ec7d6eee 2024-11-17)

editor or extension: Visual Studio Code

relevant settings: None

repository link (if public, optional): None

code snippet to reproduce:

#![feature(trait_alias)]

trait Foo {}
trait Bar {}

trait MyTrait = Foo + Bar;

when hovering over MyTrait (to see the documentation, for example) it ends up like this

trait MyTrait = 
where
    Self: Foo + Bar

it looks a little weird,

Extra

rustdoc does not do this

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

Reproduce the trait-alias hover in Visual Studio Code using the provided Rust snippet, then compare its documentation with rustdoc's output. Trace the hover rendering for MyTrait; done means the displayed alias documentation no longer includes the unexpected empty where formatting.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.