Skip to content

Commit

Permalink
Modified the JavaDoc to better suit the returning values of the funct…
Browse files Browse the repository at this point in the history
…ion Request.filterWith (junit-team#1391)
  • Loading branch information
Ramon Raya authored and kcooney committed Nov 23, 2016
1 parent a068272 commit a73dc0d
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions src/main/java/org/junit/runner/Request.java
Original file line number Diff line number Diff line change
Expand Up @@ -131,13 +131,16 @@ public Request filterWith(Filter filter) {
}

/**
* Returns a Request that only runs contains tests whose {@link Description}
* equals <code>desiredDescription</code>
* Returns a Request that only runs tests whose {@link Description}
* matches the given description.
*
* @param desiredDescription {@link Description} of those tests that should be run
* <p>Returns an empty {@code Request} if {@code desiredDescription} is not a single test and filters all but the single
* test if {@code desiredDescription} is a single test.</p>
*
* @param desiredDescription {@code Description} of those tests that should be run
* @return the filtered Request
*/
public Request filterWith(final Description desiredDescription) {
public Request filterWith(Description desiredDescription) {
return filterWith(Filter.matchMethodDescription(desiredDescription));
}

Expand Down

0 comments on commit a73dc0d

Please sign in to comment.