add docs to say "Users should use net.jqwik.api.Tag rather than org.junit.jupiter.api.Tag"#193
Merged
jlink merged 1 commit intojqwik-team:mainfrom Jun 12, 2021
Merged
Conversation
3 tasks
Collaborator
|
@chia7712 Where in the userguide/javadoc would you expect this clarification? |
Contributor
Author
|
@jlink thanks for your response.
The |
jlink
reviewed
Jun 12, 2021
Collaborator
jlink
left a comment
jlink
left a comment
There was a problem hiding this comment.
Sorry for my delayed feedback. There's this minor typo. If you don't find the time I can also fix it myself.
|
|
||
| Tags must follow certain rules as described | ||
| [here](/docs/snapshot/javadoc/net/jqwik/api/Tag.html) | ||
| [here](/docs/snapshot/javadoc/net/jqwik/api/Tag.html). Noted that the `@Tag` you'll |
Collaborator
There was a problem hiding this comment.
"Noted that" -> "Note that"
Contributor
Author
|
@jlink thanks for approving this patch :) |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Overview
The junit 5
org.junit.jupiter.api.Tagdoes not work for jqwik and the replacement isnet.jqwik.api.Tag. It seems to me that it is worth adding a doc for annotation interpretation.Details
I file this PR for (apache/kafka#10791). Kafka leverages jqwik to write tests for new module and I just noticed that junit 5 tag is not compatible to jqwik.
I hereby agree to the terms of the jqwik Contributor Agreement.