Bad test return type example [attributes.testing.test.allowed-positions]

Open Beginner friendly
#1,714 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
rust
Domain
documentation

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.

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.

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.