Add checks for README examples and fix typo #407
Merged
Conversation
This file contains 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
|
Hi @GuillaumeGomez, this is super cool! Thanks a lot for the fix and for showing me this technique. |
mgeisler
added a commit
that referenced
this pull request
Jul 8, 2021
We’ve gotten doctests for the README in #407. This PR changes the output on test failures from test src/lib.rs - (line 267) ... FAILED to test src/lib.rs - readme_doctest (line 268) ... FAILED which is slightly more informative. The line numbers are still off since I imagine they’re a combination of the line number in ‘lib.rs’ and ‘README.md’, but at least we now have an indication of where the error comes from. Finding the broken example should be easy then.
Merged
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.
You had a small typo in one of your examples, so I fixed it and added a check for it. I added the
doc-commentdependency as a dev-dependency.