BurntSushi / BurntSushi/quickcheck
`Gen::new` and `Gen::from_size_and_seed` have confusing documentation
Open
- Dominant language
- Rust
- Stars
- 2.8k
- Forks
- 165
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/BurntSushi/quickcheck/blob/692527d1d9fc9043a70b7d2bf436902e2d0f595b/src/arbitrary.rs#L45-L46
I don't understand what
> but is and should not be used
is supposed to say. Perhaps "is *not*"?
Contributor guide
No contributing guide indexed for this repository
Research direction
Open src/arbitrary.rs at lines 45-46 and read the documentation for Gen::new and Gen::from_size_and_seed in context. Clarify the confusing wording, then verify that the rendered Rust documentation accurately describes both constructors.
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