diff options
| author | Tobias Stolzmann <tobias.stolzmann@gmail.com> | 2018-05-31 20:01:03 +0200 |
|---|---|---|
| committer | Tobias Stolzmann <tobias.stolzmann@gmail.com> | 2018-06-05 12:03:54 +0200 |
| commit | 089da06cc437aa4764f958ff441e79d7fca6b148 (patch) | |
| tree | 39d89603d4fc99bd05890320016fb2be6dfed4b5 /src | |
| parent | 63885f7f72974f71d08d21bf79676ef4dc1ccaf8 (diff) | |
| download | rust-089da06cc437aa4764f958ff441e79d7fca6b148.tar.gz rust-089da06cc437aa4764f958ff441e79d7fca6b148.zip | |
Improve wording
Diffstat (limited to 'src')
| -rw-r--r-- | src/doc/rustdoc/src/documentation-tests.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/doc/rustdoc/src/documentation-tests.md b/src/doc/rustdoc/src/documentation-tests.md index 1fa385d652f..2de69924b74 100644 --- a/src/doc/rustdoc/src/documentation-tests.md +++ b/src/doc/rustdoc/src/documentation-tests.md @@ -171,8 +171,9 @@ explanation. ## Using `?` in doc tests -A complete error handling is often not useful in your example, as it would add -significant amounts of boilerplate code. Instead, you may want the following: +When writing an example, it is rarely useful to include a complete error +handling, as it would add significant amounts of boilerplate code. Instead, you +may want the following: ```ignore /// ``` |