Skip to content

Commit

Permalink
Fix faulty links in documentation (#691)
Browse files Browse the repository at this point in the history
To find broken/dead links, I used:
https://www.deadlinkchecker.com/website-dead-link-checker.asp

Closes: #691
  • Loading branch information
nipafx committed Nov 18, 2022
1 parent 8c2aa67 commit a7a639a
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions docs/cartesian-product.adoc
Expand Up @@ -286,10 +286,10 @@ include::{demo}[tag=cartesian_bad_examples]
== Writing your own `@ArgumentsSource` for `@CartesianTest`

You might find that the available annotations do not fit your need.
For a `@ParameterizedTest`, you can write a custom https://junit.org/junit5/docs/current/api/org.junit.jupiter.params/org/junit/jupiter/params/provider/ArgumentsSource.html::[`@ArgumentsSource`] and a corresponding https://junit.org/junit5/docs/current/api/org.junit.jupiter.params/org/junit/jupiter/params/provider/ArgumentsProvider.html::[`ArgumentsProvider`].
For a `@ParameterizedTest`, you can write a custom https://junit.org/junit5/docs/current/api/org.junit.jupiter.params/org/junit/jupiter/params/provider/ArgumentsSource.html[`@ArgumentsSource`] and a corresponding https://junit.org/junit5/docs/current/api/org.junit.jupiter.params/org/junit/jupiter/params/provider/ArgumentsProvider.html[`ArgumentsProvider`].
You can do the same thing for `@CartesianTest`, with the following caveats:

- Instead of `@ArgumentsSource`, you have to use https://javadoc.io/static/org.junit-pioneer/junit-pioneer/1.5.0/org/junitpioneer/jupiter/cartesian/CartesianArgumentsSource.html::[`@CartesianArgumentsSource`]
- Instead of `@ArgumentsSource`, you have to use https://javadoc.io/static/org.junit-pioneer/junit-pioneer/1.6.0/org/junitpioneer/jupiter/cartesian/CartesianArgumentsSource.html[`@CartesianArgumentsSource`]
- Instead of `ArgumentsProvider`, you have to use one of two interfaces, each explored in their own section.

=== Implementing `CartesianParameterArgumentsProvider`
Expand Down Expand Up @@ -405,7 +405,7 @@ Basic bit test
└─ 4 => first bit: 1 second bit: 1
----

Please note that name is a https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/text/MessageFormat.html::[`MessageFormat`] pattern.
Please note that name is a https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/text/MessageFormat.html[`MessageFormat`] pattern.
A single quote (') needs to be represented as a doubled single quote ('') in order to be displayed.

`CartesianTest` supports the following placeholders in custom display names:
Expand Down
4 changes: 2 additions & 2 deletions docs/report-entries.adoc
Expand Up @@ -4,7 +4,7 @@
:demo: {xp-demo-dir}/org/junitpioneer/jupiter/ReportEntryExtensionDemo.java

You can use `@ReportEntry` as a simple way to declaratively add metadata to test methods.
From the https://https://junit.org/junit5/docs/current/user-guide/#writing-tests-dependency-injection[JUnit 5 documentation]:
From the https://junit.org/junit5/docs/current/user-guide/#writing-tests-dependency-injection[JUnit 5 documentation]:

> In JUnit Jupiter you should use `TestReporter` where you used to print information to `stdout` or `stderr` in JUnit 4.
> Using `@RunWith(JUnitPlatform.class)` will output all reported entries to `stdout`.
Expand All @@ -14,7 +14,7 @@ To see how `@ReportEntry` helps, let's first take a look at the conventional app

== Standard Use of `TestReporter`

From the https://https://junit.org/junit5/docs/current/user-guide/#writing-tests-dependency-injection[JUnit 5 documentation]:
From the https://junit.org/junit5/docs/current/user-guide/#writing-tests-dependency-injection[JUnit 5 documentation]:

> If a constructor or method parameter is of type `TestReporter`, the `TestReporterParameterResolver` will supply an instance of `TestReporter`.
> The `TestReporter` can be used to publish additional data about the current test run.
Expand Down
4 changes: 2 additions & 2 deletions docs/temp-directory.adoc
Expand Up @@ -16,7 +16,7 @@ Most of the extension's features are shared with other resources, though, and ar
This includes important aspects like thread-safety, sharing resources, and cleaning up behind them (in this case, deleting the temporary directory), so make sure to read that one as well.
This temporary directory extension was introduced in JUnit Pioneer 1.9.0.
JUnit Pioneer versions before 1.0 contain link:/docs/resource-temporary-directory[a then-removed temp dir extension], which was superseded by the very similar but more powerful https://junit.org/junit5/docs/current/user-guide/#writing-tests-built-in-extensions-TempDirectory[official `@TempDir` extension] shipped with JUnit Jupiter 5.4.
JUnit Pioneer versions before 1.0 contain link:/docs/temp-directory-removed[a then-removed temp dir extension], which was superseded by the very similar but more powerful https://junit.org/junit5/docs/current/user-guide/#writing-tests-built-in-extensions-TempDirectory[official `@TempDir` extension] shipped with JUnit Jupiter 5.4.
====

== Creating a New Temporary Directory
Expand Down Expand Up @@ -59,7 +59,7 @@ To create a temporary directory that is shared by multiple tests:
include::{demo}[tag=create_shared_resource_demo]
----

See the link:resources.adoc#sharing_a_resource[ Resources page] for more information.
See the link:/docs/resources#sharing_a_resource[Resources documentation] for more information.

[NOTE]
====
Expand Down

0 comments on commit a7a639a

Please sign in to comment.