Guidelines for parts that are incomplete or undecided

Open
#2,025 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Start by reading the authoring guide and reviewing the linked examples for type.pointer.validity.pointer-fragment and macro.ambiguity.invariant.unseparated-complex-nt. Determine how the Reference currently handles incomplete or undecided behavior, then define guidance for when and how such decisions should be documented.

Written by the indexing model from the issue text.

Description

Authoring guide Meta

I think the authoring guide should have some guidelines on when something should be intentionally undecided, and how to state that. (Like certain evaluation orders.)

Some current examples:

My notes:

  • Maybe have something that talks about avoiding accidentally documenting something that is currently undecided.
    • Guidelines on when and how to make notes about parts of the language that are still undecided.
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.