implicit Option
-returning doctests
This distinguishes `Option` and `Result`-returning doctests with implicit `main` method, where the former tests must end with `Some(())`.
This commit is contained in:
parent
7da118581c
commit
6bb6c001be
3 changed files with 31 additions and 1 deletions
|
@ -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
|
that you must write the `(())` in one sequence without intermediate whitespace
|
||||||
so that rustdoc understands you want an implicit `Result`-returning function.
|
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(())
|
||||||
|
/// ```
|
||||||
|
```
|
||||||
|
|
||||||
|
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
|
## Documenting macros
|
||||||
|
|
||||||
Here’s an example of documenting a macro:
|
Here’s an example of documenting a macro:
|
||||||
|
|
|
@ -499,8 +499,13 @@ pub fn make_test(s: &str,
|
||||||
prog.push_str(everything_else);
|
prog.push_str(everything_else);
|
||||||
} else {
|
} else {
|
||||||
let returns_result = everything_else.trim_end().ends_with("(())");
|
let returns_result = everything_else.trim_end().ends_with("(())");
|
||||||
|
let returns_option = everything_else.trim_end().ends_with("Some(())");
|
||||||
let (main_pre, main_post) = if returns_result {
|
let (main_pre, main_post) = if returns_result {
|
||||||
("fn main() { fn _inner() -> Result<(), impl core::fmt::Debug> {",
|
(if returns_option {
|
||||||
|
"fn main() { fn _inner() -> Option<()> {"
|
||||||
|
} else {
|
||||||
|
"fn main() { fn _inner() -> Result<(), impl core::fmt::Debug> {"
|
||||||
|
},
|
||||||
"}\n_inner().unwrap() }")
|
"}\n_inner().unwrap() }")
|
||||||
} else {
|
} else {
|
||||||
("fn main() {\n", "\n}")
|
("fn main() {\n", "\n}")
|
||||||
|
|
|
@ -21,4 +21,16 @@
|
||||||
/// Err("This is returned from `main`, leading to panic")?;
|
/// Err("This is returned from `main`, leading to panic")?;
|
||||||
/// Ok::<(), &'static str>(())
|
/// Ok::<(), &'static str>(())
|
||||||
/// ```
|
/// ```
|
||||||
|
///
|
||||||
|
/// This also works with `Option<()>`s now:
|
||||||
|
///
|
||||||
|
/// ```rust
|
||||||
|
/// Some(())
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// ```rust,should_panic
|
||||||
|
/// let x: &[u32] = &[];
|
||||||
|
/// let _ = x.iter().next()?;
|
||||||
|
/// Some(())
|
||||||
|
/// ```
|
||||||
pub fn check_process_termination() {}
|
pub fn check_process_termination() {}
|
||||||
|
|
Loading…
Reference in a new issue