This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
fixing return types in crypto module documentation #14554
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
jtfirek
changed the title
ggwpez
approved these changes
Jul 11, 2023
primitives/core/src/crypto.rs
Outdated
| @@ -950,7 +950,7 @@ pub trait Pair: CryptoType + Sized + Clone + Send + Sync + 'static { | |||
| /// Similarly an empty password (ending the SURI with `///`) is perfectly valid and will | |||
| /// generally be equivalent to no password at all. | |||
| /// | |||
| /// `None` is returned if no matches are found. | |||
| /// an error is returned if no matches are found. | |||
There was a problem hiding this comment.
You can probably just remove this line - there are multiple reasons for an error return and I dont see the need to list them all here.
There was a problem hiding this comment.
Sorry just now seeing this @ggwpez
ggwpez
added
A2-insubstantial
bkchr
approved these changes
Jul 12, 2023
Why does this need a companion? That line makes the CI fail btw. |
|
bot merge |
|
Waiting for commit status. |
nathanwhit
pushed a commit
to nathanwhit/substrate
that referenced
this pull request
Jul 19, 2023
* fixing return types in documentation * Apply suggestions from code review --------- Co-authored-by: Bastian Köcher <git@kchr.de>
Ank4n
pushed a commit
that referenced
this pull request
Jul 22, 2023
* fixing return types in documentation * Apply suggestions from code review --------- Co-authored-by: Bastian Köcher <git@kchr.de>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
I am a student at the PBA and I came across this issue when completing the first assignment as I was reading the rust docs.
It looks a few functions in this file are documented as if they have an
Optionreturn type when they are actually returning aResultFixes the documentation for 3 functions by changing returns a
Noneto returns an ErrorI think the documentation is incorrect
They will change the rust documentation