Skip to content

Commit 9471dd0

Browse files
committed
Clarify the role of snippetsDir as a task input and output
Closes gh-892
1 parent ebc7aa3 commit 9471dd0

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/src/docs/asciidoc/getting-started.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -171,12 +171,12 @@ This will automatically configure the `snippets` attribute for use in your `.ado
171171
It will also allow you to use the `operation` block macro.
172172
<4> Add a dependency on `spring-restdocs-mockmvc` in the `testImplementation` configuration.
173173
If you want to use `WebTestClient` or REST Assured rather than MockMvc, add a dependency on `spring-restdocs-webtestclient` or `spring-restdocs-restassured` respectively instead.
174-
<5> Configure a property to define the output location for generated snippets.
175-
<6> Configure the `test` task to add the snippets directory as an output.
174+
<5> Configure a `snippetsDir` property that defines the output location for generated snippets.
175+
<6> Make Gradle aware that running the `test` task will write output to the snippetsDir. This is required for https://docs.gradle.org/current/userguide/incremental_build.html[incremental builds].
176176
<7> Configure the `asciidoctor` task.
177-
<8> Configure the snippets directory as an input.
177+
<8> Make Gradle aware that running the task will read input from the snippetsDir. This is required for https://docs.gradle.org/current/userguide/incremental_build.html[incremental builds].
178178
<9> Configure the use of the `asciidoctorExt` configuration for extensions.
179-
<10> Make the task depend on the test task so that the tests are run before the documentation is created.
179+
<10> Make the task depend on the `test` task so that the tests are run before the documentation is created.
180180

181181

182182

0 commit comments

Comments
 (0)