rust-lang / rust-lang/reference
Poor wording on enum page
Open
Nobody has claimed this yet.
Language Cleanup
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
Enumerations
"An enum where no constructors contain fields are called a field-less enum."
- grammar: are called may be changed to is called.
- possibly misleading:
"where no constructors" . The plural 'constructors' suggests that more than one constructor is allowed.
My idea:
If an enum constructor contains no fields, the enum is called a field-less enum.
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
Locate the quoted wording in the Enumerations section of the Rust Reference and read the surrounding explanation. Update the grammar and clarify the singular constructor wording as proposed, then verify the rendered documentation shows the intended sentence.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100