rust-lang / rust-lang/reference
Bad test return type example [attributes.testing.test.allowed-positions]
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
In [attributes.testing.test.allowed-positions], one of the example, Result<T, E> where T: Termination, E: Debug, is not an actual type, and as such not an example at all.
Proposed replacement: Result<(), std::io::Error>
A discussion about what constitutes a Termination type seems out of scope in the reference and subject to library change.
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
Open the attributes.testing.test.allowed-positions section in the Rust Reference and inspect the example containing Result<T, E> where T: Termination, E: Debug. Replace it with Result<(), std::io::Error> and verify that the section now shows an actual concrete return type.
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
- 65/100