rust-lang / rust-lang/reference

Add style entry for referring to editions

Open
#2,046 0 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 think the style guide should specify how to refer to editions. There has been a mix of different approaches (and also in the Edition Guide), and I would prefer to settle on one if possible. Some styles that are being used:

  • 2024 edition
  • 2024 Edition
  • edition 2024
  • Edition 2024
  • Rust 2024

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 reviewing the existing style guide and the linked Edition Guide, then compare their usage with the five forms listed in the issue. Done means selecting one consistent convention for referring to editions and documenting it in the style guide.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.