docs: updating use ? & Result instead of unwrap #860
Merged
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
ralph-mcteggart
changed the title
|
Just realised I wrote unpack in commit message 🙄 EDIT: Pushing amended commit message |
ralph-mcteggart
changed the title
ralph-mcteggart
changed the title
|
@tobz thanks for the quick look! What's normal practice from here in this repo to close out the PR and the corresponding issue? Just up to one of you guys? EDIT: saw you merged 👍 |
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.
Following on from #657
Fixing doc test to use ? with Result instead of unwrap() just to (hopefully) show better practice.
Motivation
@liranringel had mentioned that the examples needed updating but that doc tests were still to do. I checked all the remaining tests and this was the only one left that could do with a change, albeit a minor improvement.
Solution
Simply changing unwrap() to use ? operator and change function signature to return Result which would be more idiomatic for someone coming to copy this code for their own use.
This hopefully lets us close out #657