Skip to content
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

implicit Option-returning doctests #61279

Merged
merged 1 commit into from
May 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/doc/rustdoc/src/documentation-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
llogiq marked this conversation as resolved.
Show resolved Hide resolved
/// ```
/// let _ = &[].iter().next()?;
///# Some(())
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, this line should have added a space between /// #, since historically having single lines without that leading space has messed up rustdoc's Markdown parser.

Copy link
Member

Choose a reason for hiding this comment

The 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:
Expand Down
7 changes: 6 additions & 1 deletion src/librustdoc/test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -499,8 +499,13 @@ 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 {
("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() }")
} else {
("fn main() {\n", "\n}")
Expand Down
12 changes: 12 additions & 0 deletions src/test/rustdoc/process-termination.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,16 @@
/// 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() {}