-
Notifications
You must be signed in to change notification settings - Fork 13.4k
implicit Option
-returning doctests
#61279
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -253,6 +253,19 @@ conversion, so type inference fails because the type is not unique. Please note | |
that you must write the `(())` in one sequence without intermediate whitespace | ||
so that rustdoc understands you want an implicit `Result`-returning function. | ||
|
||
As of version 1.37.0, this simplification also works with `Option`s, which can | ||
be handy to test e.g. iterators or checked arithmetic, for example: | ||
|
||
```ignore | ||
/// ``` | ||
/// let _ = &[].iter().next()?; | ||
///# Some(()) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also, this line should have added a space between There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ping @llogiq |
||
/// ``` | ||
``` | ||
|
||
Note that the result must be a `Some(())` and this has to be written in one go. | ||
In this case disambiguating the result isn't required. | ||
|
||
## Documenting macros | ||
|
||
Here’s an example of documenting a macro: | ||
|
Uh oh!
There was an error while loading. Please reload this page.