rust-lang / rust-lang/rfcs

Support multilingual doc comments

Open
#2,371 4 comments 14 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

T-lang
Dominant language
Markdown
Stars
6.6k
Forks
1.7k
Avg merge
16h 14m
Merged PRs (30d)
1

Description

Sometimes our customers come from different countries, so we need to provide multilingual documents

/// #[doc(English)]
/// Hello
/// #[doc(Español)]
/// Hola
/// #[doc(日本語)]
/// こんにちは
/// #[doc(简体中文)]
/// 您好
fn hello() -> usize {
    println!("Hello");
    42
}

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 repository files, tests, or entry points are named. Start by reviewing the proposed Rust doc-comment syntax in the issue and clarifying the intended RFC scope; done would require an agreed design for multilingual documentation plus a validation and implementation plan.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.