Skip to content
Permalink
Browse files

Revert "implicit `Option`-returning doctests"

This reverts commit 6bb6c00.
  • Loading branch information...
GuillaumeGomez committed Jul 1, 2019
1 parent 765eebf commit a683bb175468354a4ebec51667fec8c3d467240f
Showing with 1 addition and 31 deletions.
  1. +0 −13 src/doc/rustdoc/src/documentation-tests.md
  2. +1 −6 src/librustdoc/test.rs
  3. +0 −12 src/test/rustdoc/process-termination.rs
@@ -253,19 +253,6 @@ 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(())
/// ```
```

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:
@@ -528,13 +528,8 @@ pub fn make_test(s: &str,
prog.push_str(everything_else);
} else {
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 {
(if returns_option {
"fn main() { fn _inner() -> Option<()> {"
} else {
"fn main() { fn _inner() -> Result<(), impl core::fmt::Debug> {"
},
("fn main() { fn _inner() -> Result<(), impl core::fmt::Debug> {",
"}\n_inner().unwrap() }")
} else {
("fn main() {\n", "\n}")
@@ -21,16 +21,4 @@
/// Err("This is returned from `main`, leading to panic")?;
/// 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() {}

0 comments on commit a683bb1

Please sign in to comment.
You can’t perform that action at this time.