rust-lang / rust-lang/rust-analyzer

Support more actions on comments

Open
#571 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-ide E-hard fun S-actionable
Dominant language
Rust
Stars
16.9k
Forks
2.2k
Avg merge
1d 12h
Merged PRs (30d)
72

Description

Comments can be assumed to be (valid) markdown (after removing /// ///! ), which we can parse and operate on. This is a list of random ideas in case someone whats to play around with this.

  • fold sections based on headlines

    I.e., be able to collapse the section from # Examples to # See also in the following:

    Function that foos a bar.
    
    # Examples
    
        Some code
        Some code
        Some code
    
    # See also
    
    Baz.
    
  • Resolve intra doc links

  • Highlight and analyze code blocks

  • Run doc tests

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 choosing one of the listed comment actions and reviewing how rust-analyzer currently parses valid Markdown comments. Define the scope and completion criteria for that action, then identify the relevant implementation and tests before making changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.