async-rs / async-rs/futures-timer
Wrong parameter in rustdoc of Delay's reset method
- Dominant language
- Rust
- Stars
- 219
- Forks
- 42
- PR merge metrics
- No merged PRs in 30d
Description
The Delay reset method takes a `dur: Duration` parameter but the docs say "Resets this timeout to an new timeout which will fire at the time specified by `at`".
The docs mention the wrong parameter and the semantics seem misaligned.
Minor tweak: "**an** new timeout" should be "**a** new timeout".
Contributor guide
No contributing guide indexed for this repository
Research direction
Locate the Delay::reset entry point and read its rustdoc alongside the method signature. Update the documentation to refer to the dur parameter, correct the timeout wording and article, then run rustdoc or the project's documentation checks to confirm the rendered text.
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
- 55/100