Update Uuid::new_v4 documentation to reflect Try no longer being implemented
#521
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
It seems Uuid no longer implements `Try`, which makes Uuid::new_v4()? fail compilation. The `?` was removed from the README in commit 8962ef6 but was not removed from the rust-doc in lib.rs. Additionally, this also hides `#[cfg(feature = "v4")]` from the docs.
The doc testing of the Uuid::new_v4() example was currently disabled, but after fixing the errors in df0dc49 the test is now working again.
Tehnix
requested review from
Dylan-DPC-zz,
kinggoesgaming and
KodrAus
as code owners
|
bors r+ |
bors bot
added a commit
that referenced
this pull request
Jul 26, 2021
521: Update Uuid::new_v4 documentation to reflect `Try` no longer being implemented r=kinggoesgaming a=Tehnix
<!--
If this PR is a breaking change, ensure that you are opening it against
the `breaking` branch. If the pull request is incomplete, prepend the Title with WIP:
-->
**I'm submitting a(n)** other (documentation fix)
# Description
The current example at https://docs.rs/uuid/0.8.2/uuid/index.html#examples to generate a UUIDV4 currently does not compile, given that `Uuid` no longer implements `Try`.
This PR updates the example to match the one given in the README of this repo, along with enabling testing for it again to ensure it doesn't go out of date. I've run `cargo test --all-features` to ensure that the tests do indeed pass.
Finally, we also hide the configuration flags, `#[cfg(feature = "v4")]`, from the example, since it should not be copied by the user of the crate, if they wanted to use the example.
# Motivation
I was looking to generate a UUID V4 and unfortunately the examples in https://docs.rs/uuid/0.8.2/uuid/index.html#examples were out-of-date.
# Tests
<!-- How are these changes tested? -->
This enables the doc-test that was already there, which now compiles after updating the code in the example.
# Related Issue(s)
None that I'm aware of
Co-authored-by: Christian Kjær <ckl@codetalk.io>
Co-authored-by: Christian Kjaer Laustsen <ckl@codetalk.io>
|
Timed out. |
|
bors r+ |
bors bot
added a commit
that referenced
this pull request
Aug 3, 2021
521: Update Uuid::new_v4 documentation to reflect `Try` no longer being implemented r=KodrAus a=Tehnix
<!--
If this PR is a breaking change, ensure that you are opening it against
the `breaking` branch. If the pull request is incomplete, prepend the Title with WIP:
-->
**I'm submitting a(n)** other (documentation fix)
# Description
The current example at https://docs.rs/uuid/0.8.2/uuid/index.html#examples to generate a UUIDV4 currently does not compile, given that `Uuid` no longer implements `Try`.
This PR updates the example to match the one given in the README of this repo, along with enabling testing for it again to ensure it doesn't go out of date. I've run `cargo test --all-features` to ensure that the tests do indeed pass.
Finally, we also hide the configuration flags, `#[cfg(feature = "v4")]`, from the example, since it should not be copied by the user of the crate, if they wanted to use the example.
# Motivation
I was looking to generate a UUID V4 and unfortunately the examples in https://docs.rs/uuid/0.8.2/uuid/index.html#examples were out-of-date.
# Tests
<!-- How are these changes tested? -->
This enables the doc-test that was already there, which now compiles after updating the code in the example.
# Related Issue(s)
None that I'm aware of
Co-authored-by: Christian Kjær <ckl@codetalk.io>
Co-authored-by: Christian Kjaer Laustsen <ckl@codetalk.io>
|
Timed out. |
|
@KodrAus Hmm, is there anything I can do from my end w.r.t. the timeouts? (I don't have permission to the Bors output, so can't see what goes wrong) :/ |
|
@KodrAus r+ |
|
That should do it 😁 |
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 fix)
Description
The current example at https://docs.rs/uuid/0.8.2/uuid/index.html#examples to generate a UUIDV4 currently does not compile, given that
Uuidno longer implementsTry.This PR updates the example to match the one given in the README of this repo, along with enabling testing for it again to ensure it doesn't go out of date. I've run
cargo test --all-featuresto ensure that the tests do indeed pass.Finally, we also hide the configuration flags,
#[cfg(feature = "v4")], from the example, since it should not be copied by the user of the crate, if they wanted to use the example.Motivation
I was looking to generate a UUID V4 and unfortunately the examples in https://docs.rs/uuid/0.8.2/uuid/index.html#examples were out-of-date.
Tests
This enables the doc-test that was already there, which now compiles after updating the code in the example.
Related Issue(s)
None that I'm aware of