rust-lang / rust-lang/reference

Policy: Past behavior

Open
#2,024 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Authoring guide Meta
Dominant language
Rust
Stars
1.6k
Forks
607
PR merge metrics
PR metrics pending

Description

I'd like the authoring guide to have guidance on whether or not to include information about past versions of Rust. If we do allow it, what is the guidance for how to do that?

I would prefer to generally avoid references to older versions, but I acknowledge that there are some rare cases where it is truly helpful. Is there some nuance or balance for that?

https://github.com/rust-lang/spec/issues/34#issuecomment-1973739688 mentions that rfc3355 says:

The specification is specific to the latest version of Rust. [...]

While the specification might include notes about the Rust version that a feature was introduced in for informative purposes (similar to standard library documentation), it does not attempt to accurately specify older, unsupported versions of Rust.

The Vision blog post says:

The descriptive definitions tell the reader how a construct will behave with
respect to a specific Rust version (e.g. Rust 1.76).

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 reading RFC 3355 and the linked Rust Reference specification discussion, then compare them with the Rust specification vision post. The work is done when the authoring guide contains agreed guidance on whether and how to discuss past Rust versions, including the permitted nuance for rare cases.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.