Clarify documentation around the relation to the rand crate #489
Conversation
This file contains 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
The rand crate changed its trait names, so these docs were referencing a trait that doesn't exist in the current version of rand. Change to be a bit more vague to avoid this getting out of date again. Also "use rand instead" wasn't very clear because "rand" doesn't contain something clearly equivalent like `get_uuid_v4`. To be clearer, add a reference to the `Builder::from_bytes` function in this crate.
carols10cents
requested review from
Dylan-DPC-zz,
kinggoesgaming and
KodrAus
as code owners
|
bors r+ |
bors bot
added a commit
that referenced
this pull request
Aug 31, 2020
489: Clarify documentation around the relation to the rand crate r=kinggoesgaming a=carols10cents **I'm submitting a(n)** other - documentation improvement # Description The rand crate changed its trait names, so these docs were referencing a trait that doesn't exist in the current version of rand. Change to be a bit more vague to avoid this getting out of date again. Also "use rand instead" wasn't very clear because "rand" doesn't contain something clearly equivalent like `get_uuid_v4`. To be clearer, add a reference to the `Builder::from_bytes` function in this crate. # Motivation It took me a few minutes to figure out what this documentation was saying, and I'd like to save someone else those few minutes in the future. # Tests N/A # Related Issue(s) None Co-authored-by: Carol (Nichols || Goulding) <[email protected]>
kinggoesgaming
approved these changes
Aug 31, 2020
|
Timed out. |
|
Hi can you merge changes from master and then I can merge |
|
Done! |
|
bors r+ |
|
Build succeeded: |
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.
I'm submitting a(n) other - documentation improvement
Description
The rand crate changed its trait names, so these docs were referencing a
trait that doesn't exist in the current version of rand. Change to be a
bit more vague to avoid this getting out of date again.
Also "use rand instead" wasn't very clear because "rand" doesn't contain
something clearly equivalent like
get_uuid_v4. To be clearer, add areference to the
Builder::from_bytesfunction in this crate.Motivation
It took me a few minutes to figure out what this documentation was saying, and I'd like to save someone else those few minutes in the future.
Tests
N/A
Related Issue(s)
None