rust-lang / rust-lang/rust-analyzer

Support folding ranges inside of doc comment code blocks

Open
#19,693 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Currently, one folding range is available - for the entire comment. It would be useful if the following were also supported:

  • ``` - the code block itself
  • All ranges inside of code blocks, as if they were normal code

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 locating rust-analyzer's folding-range handling for doc comments and compare it with the existing handling for normal code. Verify that a doc-comment code block receives its own folding range and that nested ranges inside the block are reported; add or update coverage for both behaviors if the relevant tests are found.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.