rust-lang / rust-lang/rust-mode

handle examples in docs

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

Nobody has claimed this yet.

highlighting
Dominant language
Emacs Lisp
Stars
1.3k
Forks
198
PR merge metrics
No merged PRs in 30d

Description

It would be lovely to have proper rust highlighting and handling in doc examples. e.g. when editing

//! ```
//! let x = 1;
//! ```

I would love to have rust indentation and syntax highlighting on the example code.

Contributor guide

No contributing guide indexed for this repository

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

No file or test is named in the issue. Start by locating the rust-mode entry point that handles Rust documentation examples, then inspect how the embedded example is edited. Done means the shown doc example receives Rust indentation and syntax highlighting while editing.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.