diff options
Diffstat (limited to 'docs/diff_test_doc.md')
| -rwxr-xr-x | docs/diff_test_doc.md | 19 |
1 files changed, 3 insertions, 16 deletions
diff --git a/docs/diff_test_doc.md b/docs/diff_test_doc.md index ec29077..07ce8b9 100755 --- a/docs/diff_test_doc.md +++ b/docs/diff_test_doc.md @@ -1,14 +1,12 @@ ## diff_test <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> -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 -file contents) and are in fact the same, or when the files are expected to -be different and are in fact so. +The test succeeds if the files' contents match. ### Parameters @@ -46,17 +44,6 @@ be different and are in fact so. </p> </td> </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"> <td><code>kwargs</code></td> <td> |