Skip to content

Commit

Permalink
Add stardoc target for analysis_failure_test_doc
Browse files Browse the repository at this point in the history
  • Loading branch information
FaBrand authored and Fabian Brandstetter committed Mar 16, 2022
1 parent 1c2a906 commit c74d27a
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/BUILD
Expand Up @@ -17,6 +17,13 @@ stardoc(
input = "//rules:analysis_test.bzl",
)

stardoc(
name = "analysis_failure_test_docs",
out = "analysis_failure_test_doc_gen.md",
input = "//rules:analysis_failure_test.bzl",
deps = ["//rules:analysis_failure_test"],
)

stardoc(
name = "collections_docs",
out = "collections_doc_gen.md",
Expand Down
22 changes: 22 additions & 0 deletions docs/analysis_failure_test_doc.md
@@ -0,0 +1,22 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

<a name="#analysis_failure_test"></a>

## analysis_failure_test

<pre>
analysis_failure_test(<a href="#analysis_failure_test-name">name</a>, <a href="#analysis_failure_test-error_message">error_message</a>, <a href="#analysis_failure_test-target_under_test">target_under_test</a>)
</pre>



**ATTRIBUTES**


| Name | Description | Type | Mandatory | Default |
| :-------------: | :-------------: | :-------------: | :-------------: | :-------------: |
| name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | |
| error_message | The test asserts that the given string is contained in the error message of the target under test. | String | required | |
| target_under_test | - | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | required | |


1 change: 1 addition & 0 deletions rules/BUILD
Expand Up @@ -12,6 +12,7 @@ bzl_library(
bzl_library(
name = "analysis_failure_test",
srcs = ["analysis_failure_test.bzl"],
deps = ["//lib:unittest"],
)

bzl_library(
Expand Down

0 comments on commit c74d27a

Please sign in to comment.