Minor formatting changes plus doc updates (#147)
This commit is contained in:
parent
84a12d1084
commit
67ecd63273
|
@ -31,7 +31,6 @@ Test rule checking that other targets can be successfully analyzed.
|
||||||
Args:
|
Args:
|
||||||
name: The name of the test rule.
|
name: The name of the test rule.
|
||||||
targets: A list of targets to ensure build.
|
targets: A list of targets to ensure build.
|
||||||
|
|
||||||
|
|
||||||
### Attributes
|
### Attributes
|
||||||
|
|
||||||
|
|
|
@ -1,14 +1,12 @@
|
||||||
## diff_test
|
## diff_test
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
diff_test(<a href="#diff_test-name">name</a>, <a href="#diff_test-file1">file1</a>, <a href="#diff_test-file2">file2</a>, <a href="#diff_test-expect_same">expect_same</a>, <a href="#diff_test-kwargs">kwargs</a>)
|
diff_test(<a href="#diff_test-name">name</a>, <a href="#diff_test-file1">file1</a>, <a href="#diff_test-file2">file2</a>, <a href="#diff_test-kwargs">kwargs</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
A test that compares the contents of two files.
|
A test that compares two files.
|
||||||
|
|
||||||
The test succeeds when the files are expected to be the same (with regard to
|
The test succeeds if the files' contents match.
|
||||||
file contents) and are in fact the same, or when the files are expected to
|
|
||||||
be different and are in fact so.
|
|
||||||
|
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
|
@ -46,17 +44,6 @@ be different and are in fact so.
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="diff_test-expect_same">
|
|
||||||
<td><code>expect_same</code></td>
|
|
||||||
<td>
|
|
||||||
optional. default is <code>True</code>
|
|
||||||
<p>
|
|
||||||
Whether the files are expected to be the same or not. The
|
|
||||||
test passes if this is True and the files are the same, or if this is
|
|
||||||
False and the files are not the same.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="diff_test-kwargs">
|
<tr id="diff_test-kwargs">
|
||||||
<td><code>kwargs</code></td>
|
<td><code>kwargs</code></td>
|
||||||
<td>
|
<td>
|
||||||
|
|
|
@ -55,7 +55,7 @@ unittest_toolchain(<a href="#unittest_toolchain-name">name</a>, <a href="#unitte
|
||||||
## analysistest.make
|
## analysistest.make
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
analysistest.make(<a href="#analysistest.make-impl">impl</a>, <a href="#analysistest.make-expect_failure">expect_failure</a>, <a href="#analysistest.make-config_settings">config_settings</a>)
|
analysistest.make(<a href="#analysistest.make-impl">impl</a>, <a href="#analysistest.make-expect_failure">expect_failure</a>, <a href="#analysistest.make-attrs">attrs</a>, <a href="#analysistest.make-config_settings">config_settings</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Creates an analysis test rule from its implementation function.
|
Creates an analysis test rule from its implementation function.
|
||||||
|
@ -111,6 +111,16 @@ Recall that names of test rules must end in `_test`.
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr id="analysistest.make-attrs">
|
||||||
|
<td><code>attrs</code></td>
|
||||||
|
<td>
|
||||||
|
optional. default is <code>{}</code>
|
||||||
|
<p>
|
||||||
|
An optional dictionary to supplement the attrs passed to the
|
||||||
|
unit test's `rule()` constructor.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr id="analysistest.make-config_settings">
|
<tr id="analysistest.make-config_settings">
|
||||||
<td><code>config_settings</code></td>
|
<td><code>config_settings</code></td>
|
||||||
<td>
|
<td>
|
||||||
|
@ -663,7 +673,7 @@ Recall that names of test rules must end in `_test`.
|
||||||
<tr id="unittest.make-attrs">
|
<tr id="unittest.make-attrs">
|
||||||
<td><code>attrs</code></td>
|
<td><code>attrs</code></td>
|
||||||
<td>
|
<td>
|
||||||
optional. default is <code>None</code>
|
optional. default is <code>{}</code>
|
||||||
<p>
|
<p>
|
||||||
An optional dictionary to supplement the attrs passed to the
|
An optional dictionary to supplement the attrs passed to the
|
||||||
unit test's `rule()` constructor.
|
unit test's `rule()` constructor.
|
||||||
|
|
|
@ -52,6 +52,5 @@ analysis_test = rule(
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
name: The name of the test rule.
|
name: The name of the test rule.
|
||||||
targets: A list of targets to ensure build.
|
targets: A list of targets to ensure build.""",
|
||||||
""",
|
|
||||||
)
|
)
|
||||||
|
|
|
@ -15,7 +15,7 @@
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
#
|
#
|
||||||
# End to end tests for analysis_test.bzl.
|
# End to end tests for analysis_test.bzl.
|
||||||
#
|
#
|
||||||
# End to end tests of analysis_test.bzl cover verification that
|
# End to end tests of analysis_test.bzl cover verification that
|
||||||
# analysis_test tests fail when their underlying test targets fail analysis.
|
# analysis_test tests fail when their underlying test targets fail analysis.
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,7 @@
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
#
|
#
|
||||||
# End to end tests for unittest.bzl.
|
# End to end tests for unittest.bzl.
|
||||||
#
|
#
|
||||||
# Specifically, end to end tests of unittest.bzl cover verification that
|
# Specifically, end to end tests of unittest.bzl cover verification that
|
||||||
# analysis-phase tests written with unittest.bzl appropriately
|
# analysis-phase tests written with unittest.bzl appropriately
|
||||||
# cause test failures in cases where violated assertions are made.
|
# cause test failures in cases where violated assertions are made.
|
||||||
|
|
Loading…
Reference in New Issue