Remove main function from doctests #752
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In order to use the ? operator, we need to make it clear the function returns a result instead of unit: https://doc.rust-lang.org/rustdoc/documentation-tests.html#using--in-doc-tests
src/impl_constructors.rs
Outdated
| @@ -132,18 +132,13 @@ where | |||
| /// use approx::assert_abs_diff_eq; | |||
| /// use ndarray::{Array, arr1}; | |||
| /// | |||
| /// # fn example() -> Option<()> { | |||
There was a problem hiding this comment.
Does this cause a clippy failure? Given that the return type is Option<()> I wouldn't an expect this to be deemed a needless_doctest_main.
There was a problem hiding this comment.
Lemme double-check why I've done so. It might be for the sake of simplicity for the example, but I agree it wouldn't be the exact scope of this pull request.
Given I couldn't find an explanation in the commit message (I usually leave explanatory messages), going to re-run it.
There was a problem hiding this comment.
Yep, running fine with the example function. So it was, indeed, a matter of simplicity
LukeMathWalker
approved these changes
Nov 20, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull requests addresses the needless_doctest_main linting issues.
Most of the remaining ones are with regards missing
Safetysection in the docs, using clippy words, missing_safety_doc, which was added by rust-lang/rust-clippy#4608. Those aren't as straightforward for fixing as they require a per-case analysis in order to verify the safety pre-requisites.There is also one occurrency of a redundant clone