about summary refs log tree commit diff
path: root/src/test/rustdoc
diff options
context:
space:
mode:
authorAndre Bogus <bogusandre@gmail.com>2018-12-03 18:16:20 +0100
committerAndre Bogus <bogusandre@gmail.com>2019-02-17 16:42:49 +0100
commitdad211ef9fdcef5328813a1907d323303f09fc6c (patch)
treeccb9785522c11eb483b9bf6c5addeacdb1ec8c31 /src/test/rustdoc
parent007115746c6d0234742719dd67efba054abe97ce (diff)
downloadrust-dad211ef9fdcef5328813a1907d323303f09fc6c.tar.gz
rust-dad211ef9fdcef5328813a1907d323303f09fc6c.zip
Modify doctest's auto-`fn main()` to allow `Result`s
This lets the default `fn main()` unwrap any `Result`s, which
allows the use of `?` in most tests without adding it manually.
Diffstat (limited to 'src/test/rustdoc')
-rw-r--r--src/test/rustdoc/process-termination.rs24
1 files changed, 24 insertions, 0 deletions
diff --git a/src/test/rustdoc/process-termination.rs b/src/test/rustdoc/process-termination.rs
new file mode 100644
index 00000000000..32258792b6e
--- /dev/null
+++ b/src/test/rustdoc/process-termination.rs
@@ -0,0 +1,24 @@
+// compile-flags:--test
+
+/// A check of using various process termination strategies
+///
+/// # Examples
+///
+/// ```rust
+/// assert!(true); // this returns `()`, all is well
+/// ```
+///
+/// You can also simply return `Ok(())`, but you'll need to disambiguate the
+/// type using turbofish, because we cannot infer the type:
+///
+/// ```rust
+/// Ok::<(), &'static str>(())
+/// ```
+///
+/// You can err with anything that implements `Debug`:
+///
+/// ```rust,should_panic
+/// Err("This is returned from `main`, leading to panic")?;
+/// Ok::<(), &'static str>(())
+/// ```
+pub fn check_process_termination() {}