docs: update return signature for try_from_os_str #3818
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
mbhall88
changed the title
epage
reviewed
Jun 13, 2022
examples/derive_ref/README.md
Outdated
| @@ -268,7 +268,7 @@ You can then support your custom type with `#[clap(parse(<kind> [= <function>])) | |||
| | `from_str` | `fn(&str) -> T` | `::std::convert::From::from` | | |||
| | `try_from_str` (default) | `fn(&str) -> Result<T, E>` | `::std::str::FromStr::from_str` | | |||
| | `from_os_str` | `fn(&OsStr) -> T` | `::std::convert::From::from` | | |||
| | `try_from_os_str` | `fn(&OsStr) -> Result<T, OsString>` | (no default function) | | |||
| | `try_from_os_str` | `fn(&OsStr) -> Result<T, String>` | (no default function) | | |||
There was a problem hiding this comment.
When I was trying to use OsString I was unable to compile with the error error[E0277]:
OsStringdoesn't implementstd::fmt::Display. Changing the error type to String fixed this.
Sounds like this should be E like try_from_str's signature.
There was a problem hiding this comment.
Updated in the latest commit
|
Thanks! |
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.
Small documentation fix to update the documentedt expected signature of
try_from_os_str. The error type of the returnResultwas stated asOsString, but it is actuallyString. This is confirmed by this testclap/tests/derive/legacy/custom_string_parsers.rs
Line 109 in e8ad62b
When I was trying to use
OsStringI was unable to compile with the errorerror[E0277]: `OsString` doesn't implement `std::fmt::Display`. Changing the error type toStringfixed this.