docs: added rustdoc with examples and panic sections to all structs a… #17
IndecisiveCrab
This run and associated checks have been archived and are scheduled for deletion.
Learn more about checks retention
Annotations
18 errors
|
item in documentation is missing backticks:
src/lib.rs#L74
error: item in documentation is missing backticks
--> src/lib.rs:74:62
|
74 | //! When the [Err]-value implements [PartialEq] one can use [and_error_equals](struct.ErrAsserter.html#method.and_error_equals)
| ^^^^^^^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
74 | //! When the [Err]-value implements [PartialEq] one can use [`and_error_equals`](struct.ErrAsserter.html#method.and_error_equals)
| ~~~~~~~~~~~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L74
error: item in documentation is missing backticks
--> src/lib.rs:74:38
|
74 | //! When the [Err]-value implements [PartialEq] one can use [and_error_equals](struct.ErrAsserter.html#method.and_error_equals)
| ^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
74 | //! When the [Err]-value implements [`PartialEq`] one can use [and_error_equals](struct.ErrAsserter.html#method.and_error_equals)
| ~~~~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L43
error: item in documentation is missing backticks
--> src/lib.rs:43:97
|
43 | //! Results can be asserted by calling [is_err](struct.AssertionBuilder.html#method.is_err) or [is_ok](struct.AssertionBuilder.html#metho...
| ^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
43 | //! Results can be asserted by calling [is_err](struct.AssertionBuilder.html#method.is_err) or [`is_ok`](struct.AssertionBuilder.html#method.is_ok).
| ~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L43
error: item in documentation is missing backticks
--> src/lib.rs:43:41
|
43 | //! Results can be asserted by calling [is_err](struct.AssertionBuilder.html#method.is_err) or [is_ok](struct.AssertionBuilder.html#metho...
| ^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
43 | //! Results can be asserted by calling [`is_err`](struct.AssertionBuilder.html#method.is_err) or [is_ok](struct.AssertionBuilder.html#method.is_ok).
| ~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L29
error: item in documentation is missing backticks
--> src/lib.rs:29:188
|
29 | ...onBuilder.html#method.try_into_not_equals) but here the trait [TryInto] is used.
| ^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
29 | //! Same for [try_into_equals](struct.AssertionBuilder.html#method.try_into_equals) and [try_into_not_equals](struct.AssertionBuilder.html#method.try_into_not_equals) but here the trait [`TryInto`] is used.
| ~~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L29
error: item in documentation is missing backticks
--> src/lib.rs:29:90
|
29 | //! Same for [try_into_equals](struct.AssertionBuilder.html#method.try_into_equals) and [try_into_not_equals](struct.AssertionBuilder.htm...
| ^^^^^^^^^^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
29 | //! Same for [try_into_equals](struct.AssertionBuilder.html#method.try_into_equals) and [`try_into_not_equals`](struct.AssertionBuilder.html#method.try_into_not_equals) but here the trait [TryInto] is used.
| ~~~~~~~~~~~~~~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L29
error: item in documentation is missing backticks
--> src/lib.rs:29:15
|
29 | //! Same for [try_into_equals](struct.AssertionBuilder.html#method.try_into_equals) and [try_into_not_equals](struct.AssertionBuilder.htm...
| ^^^^^^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
29 | //! Same for [`try_into_equals`](struct.AssertionBuilder.html#method.try_into_equals) and [try_into_not_equals](struct.AssertionBuilder.html#method.try_into_not_equals) but here the trait [TryInto] is used.
| ~~~~~~~~~~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L14
error: item in documentation is missing backticks
--> src/lib.rs:14:63
|
14 | //! [equals](struct.AssertionBuilder.html#method.equals) and [not_equals](struct.AssertionBuilder.html#method.not_equals) take anything t...
| ^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
14 | //! [equals](struct.AssertionBuilder.html#method.equals) and [`not_equals`](struct.AssertionBuilder.html#method.not_equals) take anything that can be converted to the asserted type to improve ergonimics.
| ~~~~~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L5
error: item in documentation is missing backticks
--> src/lib.rs:5:41
|
5 | //! All asserted are stared by calling [assert_that] on a value.
| ^^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
note: the lint level is defined here
--> src/lib.rs:107:9
|
107 | #![deny(clippy::pedantic, clippy::nursery)]
| ^^^^^^^^^^^^^^^^
= note: `#[deny(clippy::doc_markdown)]` implied by `#[deny(clippy::pedantic)]`
help: try
|
5 | //! All asserted are stared by calling [`assert_that`] on a value.
| ~~~~~~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L74
error: item in documentation is missing backticks
--> src/lib.rs:74:62
|
74 | //! When the [Err]-value implements [PartialEq] one can use [and_error_equals](struct.ErrAsserter.html#method.and_error_equals)
| ^^^^^^^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
74 | //! When the [Err]-value implements [PartialEq] one can use [`and_error_equals`](struct.ErrAsserter.html#method.and_error_equals)
| ~~~~~~~~~~~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L74
error: item in documentation is missing backticks
--> src/lib.rs:74:38
|
74 | //! When the [Err]-value implements [PartialEq] one can use [and_error_equals](struct.ErrAsserter.html#method.and_error_equals)
| ^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
74 | //! When the [Err]-value implements [`PartialEq`] one can use [and_error_equals](struct.ErrAsserter.html#method.and_error_equals)
| ~~~~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L43
error: item in documentation is missing backticks
--> src/lib.rs:43:97
|
43 | //! Results can be asserted by calling [is_err](struct.AssertionBuilder.html#method.is_err) or [is_ok](struct.AssertionBuilder.html#metho...
| ^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
43 | //! Results can be asserted by calling [is_err](struct.AssertionBuilder.html#method.is_err) or [`is_ok`](struct.AssertionBuilder.html#method.is_ok).
| ~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L43
error: item in documentation is missing backticks
--> src/lib.rs:43:41
|
43 | //! Results can be asserted by calling [is_err](struct.AssertionBuilder.html#method.is_err) or [is_ok](struct.AssertionBuilder.html#metho...
| ^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
43 | //! Results can be asserted by calling [`is_err`](struct.AssertionBuilder.html#method.is_err) or [is_ok](struct.AssertionBuilder.html#method.is_ok).
| ~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L29
error: item in documentation is missing backticks
--> src/lib.rs:29:188
|
29 | ...onBuilder.html#method.try_into_not_equals) but here the trait [TryInto] is used.
| ^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
29 | //! Same for [try_into_equals](struct.AssertionBuilder.html#method.try_into_equals) and [try_into_not_equals](struct.AssertionBuilder.html#method.try_into_not_equals) but here the trait [`TryInto`] is used.
| ~~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L29
error: item in documentation is missing backticks
--> src/lib.rs:29:90
|
29 | //! Same for [try_into_equals](struct.AssertionBuilder.html#method.try_into_equals) and [try_into_not_equals](struct.AssertionBuilder.htm...
| ^^^^^^^^^^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
29 | //! Same for [try_into_equals](struct.AssertionBuilder.html#method.try_into_equals) and [`try_into_not_equals`](struct.AssertionBuilder.html#method.try_into_not_equals) but here the trait [TryInto] is used.
| ~~~~~~~~~~~~~~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L29
error: item in documentation is missing backticks
--> src/lib.rs:29:15
|
29 | //! Same for [try_into_equals](struct.AssertionBuilder.html#method.try_into_equals) and [try_into_not_equals](struct.AssertionBuilder.htm...
| ^^^^^^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
29 | //! Same for [`try_into_equals`](struct.AssertionBuilder.html#method.try_into_equals) and [try_into_not_equals](struct.AssertionBuilder.html#method.try_into_not_equals) but here the trait [TryInto] is used.
| ~~~~~~~~~~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L14
error: item in documentation is missing backticks
--> src/lib.rs:14:63
|
14 | //! [equals](struct.AssertionBuilder.html#method.equals) and [not_equals](struct.AssertionBuilder.html#method.not_equals) take anything t...
| ^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
|
14 | //! [equals](struct.AssertionBuilder.html#method.equals) and [`not_equals`](struct.AssertionBuilder.html#method.not_equals) take anything that can be converted to the asserted type to improve ergonimics.
| ~~~~~~~~~~~~
|
|
item in documentation is missing backticks:
src/lib.rs#L5
error: item in documentation is missing backticks
--> src/lib.rs:5:41
|
5 | //! All asserted are stared by calling [assert_that] on a value.
| ^^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
note: the lint level is defined here
--> src/lib.rs:107:9
|
107 | #![deny(clippy::pedantic, clippy::nursery)]
| ^^^^^^^^^^^^^^^^
= note: `#[deny(clippy::doc_markdown)]` implied by `#[deny(clippy::pedantic)]`
help: try
|
5 | //! All asserted are stared by calling [`assert_that`] on a value.
| ~~~~~~~~~~~~~
|