honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-03-25 09:28:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document how to run a single docs test

Browse Source
This commit is contained in:
Clinton Gormley 2016-10-06 21:10:49 +02:00
parent a6fa96d513
commit d822a642b0
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/README.asciidoc
View File

@ -5,7 +5,10 @@ See: https://github.com/elastic/docs
Snippets marked with `// CONSOLE` are automatically annotated with "VIEW IN
SENSE" in the documentation and are automatically tested by the command
`gradle :docs:check`. By default `// CONSOLE` snippet runs as its own isolated
`gradle :docs:check`. To test just the docs from a single page, use e.g.
`gradle :docs:check -Dtest.method=*rollover*`.
By default `// CONSOLE` snippet runs as its own isolated
test. You can manipulate the test execution in the following ways:
* `// TEST`: Explicitly marks a snippet as a test. Snippets marked this way