rust-lang / rust-lang/rust-analyzer

Rust Code Blocks in Documentation Are Not Well Highlighted

Open
#13,845 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

rust-analyzer version: 0.4.1330-standalone (fb0db2a42 2022-12-23)

rustc version: rustc 1.68.0-nightly (rust-lang/rust@af3e06f1b 2022-12-23)

relevant settings: (No special settings)

The problems are described by the following image:
image

Compared to the normal code rendered:
image

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 comparing the affected and normal rendered code shown in the two linked screenshots, then locate the documentation rendering and syntax-highlighting entry point. The issue names no file or test; done means Rust code blocks in the documentation are highlighted as expected.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.