Skip to content

Commit 5bc5da1

Browse files
committed
. d reformatted code and updated markdown snippets
1 parent 56bee5c commit 5bc5da1

File tree

3 files changed

+29
-28
lines changed

3 files changed

+29
-28
lines changed

approvaltests/docs/how_to/ConfigureReporters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ All the [verify](./reference/Verify.md) functions have an overload that takes an
3838
Options options = new Options().withReporter(BeyondCompareReporter.INSTANCE);
3939
Approvals.verify(objectUnderTest, options);
4040
```
41-
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/ApprovalsTest.java#L21-L24' title='Snippet source file'>snippet source</a> | <a href='#snippet-configure_reporter_with_options' title='Start of snippet'>anchor</a></sup>
41+
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/ApprovalsTest.java#L25-L28' title='Snippet source file'>snippet source</a> | <a href='#snippet-configure_reporter_with_options' title='Start of snippet'>anchor</a></sup>
4242
<!-- endSnippet -->
4343

4444
### Method 2: Class and Method Level Annotations

approvaltests/docs/how_to/TestAVarietyOfValues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ If you have more than one parameter that you want to vary, check out [Testing Co
2525
String[] inputs = {"input.value1", "input.value2"};
2626
Approvals.verifyAll("TITLE", inputs, s -> "placeholder " + s);
2727
```
28-
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/ApprovalsTest.java#L46-L49' title='Snippet source file'>snippet source</a> | <a href='#snippet-VerifyAllStartingPoint' title='Start of snippet'>anchor</a></sup>
28+
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/ApprovalsTest.java#L50-L53' title='Snippet source file'>snippet source</a> | <a href='#snippet-VerifyAllStartingPoint' title='Start of snippet'>anchor</a></sup>
2929
<!-- endSnippet -->
3030

3131
2. Modify the input container for your chosen values.

approvaltests/docs/reference/Verify.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,32 +14,33 @@ Here is a list:
1414
*(Note: All verify functions have an [optional "Options" parameter](#optional-options) as the last parameter.)*
1515

1616

17-
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L267-L284) (ApprovalApprover, $\color{#AAA}{\textsf{Options}}$) <!-- include: DocumentHelpersTest.listAllVerifyFunctions.approved.md -->
18-
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L227-L230) (ApprovalWriter, $\color{#AAA}{\textsf{Options}}$)
19-
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L217-L220) (ApprovalWriter, ApprovalNamer, $\color{#AAA}{\textsf{Options}}$)
20-
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L291-L294) (ExecutableCommand, $\color{#AAA}{\textsf{Options}}$)
21-
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L198-L201) (File, $\color{#AAA}{\textsf{Options}}$)
22-
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L301-L304) (Map, $\color{#AAA}{\textsf{Options}}$)
23-
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L64-L68) (Object, $\color{#AAA}{\textsf{Options}}$)
24-
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L311-L314) (ResultSet, $\color{#AAA}{\textsf{Options}}$)
25-
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L321-L324) (SqlLoader, $\color{#AAA}{\textsf{Options}}$)
26-
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L54-L57) (String, $\color{#AAA}{\textsf{Options}}$)
27-
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L75-L79) (Verifiable, $\color{#AAA}{\textsf{Options}}$)
28-
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L124-L127) (Iterable, Function1, $\color{#AAA}{\textsf{Options}}$)
29-
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L129-L133) (Object[], Function1, $\color{#AAA}{\textsf{Options}}$)
30-
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L167-L170) (String, Iterable, $\color{#AAA}{\textsf{Options}}$)
31-
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L150-L155) (String, Iterable, Function1, $\color{#AAA}{\textsf{Options}}$)
32-
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L98-L101) (String, Object[], $\color{#AAA}{\textsf{Options}}$)
33-
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L140-L143) (String, Object[], Function1, $\color{#AAA}{\textsf{Options}}$)
34-
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L177-L181) (String, String, Iterable, $\color{#AAA}{\textsf{Options}}$)
35-
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L108-L112) (String, String, Object[], $\color{#AAA}{\textsf{Options}}$)
36-
* Approvals. [verifyEachFileInDirectory ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L336-L339) (File, $\color{#AAA}{\textsf{Options}}$)
37-
* Approvals. [verifyEachFileInDirectory ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L346-L349) (File, FileFilter, $\color{#AAA}{\textsf{Options}}$)
38-
* Approvals. [verifyEachFileInDirectory ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L356-L359) (File, FilenameFilter, $\color{#AAA}{\textsf{Options}}$)
39-
* Approvals. [verifyException ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L474-L480) (Action0, $\color{#AAA}{\textsf{Options}}$)
40-
* Approvals. [verifyHtml ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L188-L191) (String, $\color{#AAA}{\textsf{Options}}$)
41-
* Approvals. [verifyXml ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L237-L240) (String, $\color{#AAA}{\textsf{Options}}$)
42-
* Approvals. [verifyXml ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L247-L251) (String, Function1, $\color{#AAA}{\textsf{Options}}$)
17+
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L278-L295) (ApprovalApprover, $\color{#AAA}{\textsf{Options}}$) <!-- include: DocumentHelpersTest.listAllVerifyFunctions.approved.md -->
18+
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L238-L241) (ApprovalWriter, $\color{#AAA}{\textsf{Options}}$)
19+
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L228-L231) (ApprovalWriter, ApprovalNamer, $\color{#AAA}{\textsf{Options}}$)
20+
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L302-L305) (ExecutableCommand, $\color{#AAA}{\textsf{Options}}$)
21+
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L209-L212) (File, $\color{#AAA}{\textsf{Options}}$)
22+
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L312-L315) (Map, $\color{#AAA}{\textsf{Options}}$)
23+
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L65-L69) (Object, $\color{#AAA}{\textsf{Options}}$)
24+
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L199-L202) (Path, $\color{#AAA}{\textsf{Options}}$)
25+
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L322-L325) (ResultSet, $\color{#AAA}{\textsf{Options}}$)
26+
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L332-L335) (SqlLoader, $\color{#AAA}{\textsf{Options}}$)
27+
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L55-L58) (String, $\color{#AAA}{\textsf{Options}}$)
28+
* Approvals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L76-L80) (Verifiable, $\color{#AAA}{\textsf{Options}}$)
29+
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L125-L128) (Iterable, Function1, $\color{#AAA}{\textsf{Options}}$)
30+
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L130-L134) (Object[], Function1, $\color{#AAA}{\textsf{Options}}$)
31+
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L168-L171) (String, Iterable, $\color{#AAA}{\textsf{Options}}$)
32+
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L151-L156) (String, Iterable, Function1, $\color{#AAA}{\textsf{Options}}$)
33+
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L99-L102) (String, Object[], $\color{#AAA}{\textsf{Options}}$)
34+
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L141-L144) (String, Object[], Function1, $\color{#AAA}{\textsf{Options}}$)
35+
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L178-L182) (String, String, Iterable, $\color{#AAA}{\textsf{Options}}$)
36+
* Approvals. [verifyAll ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L109-L113) (String, String, Object[], $\color{#AAA}{\textsf{Options}}$)
37+
* Approvals. [verifyEachFileInDirectory ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L347-L350) (File, $\color{#AAA}{\textsf{Options}}$)
38+
* Approvals. [verifyEachFileInDirectory ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L357-L360) (File, FileFilter, $\color{#AAA}{\textsf{Options}}$)
39+
* Approvals. [verifyEachFileInDirectory ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L367-L370) (File, FilenameFilter, $\color{#AAA}{\textsf{Options}}$)
40+
* Approvals. [verifyException ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L485-L491) (Action0, $\color{#AAA}{\textsf{Options}}$)
41+
* Approvals. [verifyHtml ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L189-L192) (String, $\color{#AAA}{\textsf{Options}}$)
42+
* Approvals. [verifyXml ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L248-L251) (String, $\color{#AAA}{\textsf{Options}}$)
43+
* Approvals. [verifyXml ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/Approvals.java#L258-L262) (String, Function1, $\color{#AAA}{\textsf{Options}}$)
4344
* AwtApprovals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/awt/AwtApprovals.java#L47-L50) (BufferedImage, $\color{#AAA}{\textsf{Options}}$)
4445
* AwtApprovals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/awt/AwtApprovals.java#L57-L60) (Component, $\color{#AAA}{\textsf{Options}}$)
4546
* AwtApprovals. [verify ](https://github.com/approvals/ApprovalTests.Java/blob/master/approvaltests/src/main/java/org/approvaltests/awt/AwtApprovals.java#L37-L40) (Image, $\color{#AAA}{\textsf{Options}}$)

0 commit comments

Comments
 (0)