Should we document when features are stabilized?

Open
#60 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Review the Rust Reference’s language-feature sections alongside the standard library documentation’s existing stabilization information. Determine whether stabilization versions belong in the Reference and define a consistent scope; done means the policy is decided and the relevant documentation is updated accordingly.

Written by the indexing model from the issue text.

Description

Authoring guide C-discussion Meta

The standard library documentation documents what version that various types, functions, and what not are stabilized. Since there's no "API docs" for features, other than this reference, should we be documenting when language features are stabilized into the reference?

Dominant language
Rust
Stars
1.6k
Forks
607
Avg merge
1d 1h
Merged PRs (30d)
12

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.

More from rust-lang/reference

All issues in rust-lang/reference

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.