docs: fix angle unit in quick start example (#1837) - #1839
Merged
dhardy merged 1 commit intoSep 8, 2026
Conversation
The ranged sampling example in src/lib.rs samples an angle from -PI..PI, which corresponds to radians rather than degrees. Fixes rust-random#1837
dhardy
approved these changes
Sep 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the unit mentioned in the quick start documentation example in
src/lib.rs.Motivation
Resolves #1837. The ranged sampling example samples a value from
-PI..PI. A range of[-π, π]corresponds to radians rather than degrees, so printing"degrees"was misleading for readers running or copying the example.Details
Updated
src/lib.rs:Tested with
cargo test --docandcargo clippy --all-targets(all clean).