rust-lang / rust-lang/reference
Guidelines for parts that are incomplete or undecided
Open
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 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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100