Document that doctest filters match line-by-line #1720
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
fredrikekre
reviewed
Oct 25, 2021
docs/src/man/doctests.md
Outdated
| @@ -300,6 +300,12 @@ DocTestFilters = nothing | |||
| The `DocTestFilters = nothing` is not strictly necessary, but good practice nonetheless to | |||
| help avoid unintentional filtering in following doctest blocks. | |||
|
|
|||
| !!! info | |||
| Filters are applied line-by-line to the output. To match multiline strings, | |||
There was a problem hiding this comment.
It is not line-by-line, the problem in the linked issue is just that . doesn't match newline characters. Perhaps reword to something like:
The filter match is replaced with an empty string in both the expected and actual output using
`replace`, e.g. `replace(str, filter => "")`. Note that this means that the same filter can match
multiple times, and if you need the same filter to match multiple lines your regex need to account
for that.
fredrikekre
reviewed
Jan 24, 2022
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.
Closes #1679