Skip to content

Commit

Permalink
. d updated markdown snippets
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Mar 5, 2025
1 parent 25605be commit 382d5e1
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 22 deletions.
2 changes: 1 addition & 1 deletion approvaltests/docs/Features.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Notice that for low numbers of parameters, very little is achieved, but at high
<!-- include: PairWiseTest.forTable.approved. path: /approvaltests-tests/src/test/java/org/approvaltests/combinations/PairWiseTest.forTable.approved.include.md -->

| Number of Parameters | Variations per Parameter | Total Combinations | Pairwise Combinations |
|---------------------:|-------------------------:|-------------------:|----------------------:|
| -------------------: | -----------------------: | -----------------: | --------------------: |
| 2 | 5 | 25 | 25 |
| 3 | 3 | 27 | 11 |
| 3 | 4 | 64 | 16 |
Expand Down
42 changes: 22 additions & 20 deletions approvaltests/docs/Scrubbers.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ The easiest way to scrub a date is by calling
```java
Approvals.verify("created at 03:14:15", new Options().withScrubber(DateScrubber.getScrubberFor("00:00:00")));
```
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/scrubbers/DateScrubberTest.java#L47-L49' title='Snippet source file'>snippet source</a> | <a href='#snippet-scrub-date-example' title='Start of snippet'>anchor</a></sup>
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/scrubbers/DateScrubberTest.java#L49-L51' title='Snippet source file'>snippet source</a> | <a href='#snippet-scrub-date-example' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

which will produce
Expand All @@ -124,25 +124,27 @@ created at [Date1]
### Supported formats

<!-- include: DateScrubberTest.supportedFormats.approved.md -->
| Example Date | RegEx Pattern |
| :-------------------- | :----------------------- |
| Tue May 13 16:30:00 | [a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{2}:\d{2}:\d{2} |
| Wed Nov 17 22:28:33 EET 2021 | [a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{2}:\d{2}:\d{2} [a-zA-Z]{3,4} \d{4} |
| Wed, 21 Oct 2015 07:28:00 GMT | (Mon\|Tue\|Wed\|Thu\|Fri\|Sat\|Sun), \d{2} (Jan\|Feb\|Mar\|Apr\|May\|Jun\|Jul\|Aug\|Sep\|Oct\|Nov\|Dec) \d{4} \d{2}:\d{2}:\d{2} GMT |
| Tue May 13 2014 23:30:00.789 | [a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{4} \d{2}:\d{2}:\d{2}.\d{3} |
| Tue May 13 16:30:00 -0800 2014 | [a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{2}:\d{2}:\d{2} -\d{4} \d{4} |
| 13 May 2014 23:50:49,999 | \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2},\d{3} |
| Oct 13 15:29 | [A-Za-z]{3} \d{2} \d{2}:\d{2} |
| May 13, 2014 11:30:00 PM PST | [a-zA-Z]{3} \d{2}, \d{4} \d{2}:\d{2}:\d{2} [a-zA-Z]{2} [a-zA-Z]{3} |
| 23:30:00 | \d{2}:\d{2}:\d{2} |
| 2014/05/13 16:30:59.786 | \d{4}/\d{2}/\d{2} \d{2}:\d{2}:\d{2}(\.\d{3})? |
| 2020-9-10T08:07Z | \d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}Z |
| 2020-09-10T08:07:89Z | \d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}:\d{2}Z |
| 2020-09-10T01:23:45.678Z | \d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}\:\d{2}\.\d{3}Z |
| 20210505T091112Z | \d{8}T\d{6}Z |
| 2024-12-17 | \d{4}-\d{2}-\d{2} |
| 2024-12-18T14:04:46.746130Z | \d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}:\d{2}(\.\d{1,9})?Z |
| 13/05/2014 23:50:49 | \d{2}[-/.]\d{2}[-/.]\d{4}\s\d{2}:\d{2}(:\d{2})?( (?:pm\|am\|PM\|AM))? |

| Example Date | RegEx Pattern |
| :----------------------------- | :---------------------------------------------------------------------------------------------------------------------------------- |
| Tue May 13 16:30:00 | [a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{2}:\d{2}:\d{2} |
| Wed Nov 17 22:28:33 EET 2021 | [a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{2}:\d{2}:\d{2} [a-zA-Z]{3,4} \d{4} |
| Wed, 21 Oct 2015 07:28:00 GMT | (Mon\|Tue\|Wed\|Thu\|Fri\|Sat\|Sun), \d{2} (Jan\|Feb\|Mar\|Apr\|May\|Jun\|Jul\|Aug\|Sep\|Oct\|Nov\|Dec) \d{4} \d{2}:\d{2}:\d{2} GMT |
| Tue May 13 2014 23:30:00.789 | [a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{4} \d{2}:\d{2}:\d{2}.\d{3} |
| Tue May 13 16:30:00 -0800 2014 | [a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{2}:\d{2}:\d{2} -\d{4} \d{4} |
| 13 May 2014 23:50:49,999 | \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2},\d{3} |
| Oct 13 15:29 | [A-Za-z]{3} \d{2} \d{2}:\d{2} |
| May 13, 2014 11:30:00 PM PST | [a-zA-Z]{3} \d{2}, \d{4} \d{2}:\d{2}:\d{2} [a-zA-Z]{2} [a-zA-Z]{3} |
| 23:30:00 | \d{2}:\d{2}:\d{2} |
| 2014/05/13 16:30:59.786 | \d{4}/\d{2}/\d{2} \d{2}:\d{2}:\d{2}(\.\d{3})? |
| 2020-9-10T08:07Z | \d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}Z |
| 2020-09-10T08:07:89Z | \d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}:\d{2}Z |
| 2020-09-10T01:23:45.678Z | \d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}\:\d{2}\.\d{3}Z |
| 20210505T091112Z | \d{8}T\d{6}Z |
| 2024-12-17 | \d{4}-\d{2}-\d{2} |
| 2024-12-18T14:04:46.746130Z | \d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}:\d{2}(\.\d{1,9})?Z |
| 13/05/2014 23:50:49 | \d{2}[-/.]\d{2}[-/.]\d{4}\s\d{2}:\d{2}(:\d{2})?( (?:pm\|am\|PM\|AM))? |

<!-- endInclude -->

## Scrubbing multiple parts of a string
Expand Down
2 changes: 1 addition & 1 deletion approvaltests/docs/how_to/TestAVarietyOfValues.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ which will produce:

<!-- include: TableTest.differentCases.approved.md -->
| Input | Camel Case | Snake Case | Kebab Case |
|-------------------|------------------|-------------------|-------------------|
| ----------------- | ---------------- | ----------------- | ----------------- |
| verify json | verifyJson | verify_json | verify-json |
| verify all | verifyAll | verify_all | verify-all |
| verify parameters | verifyParameters | verify_parameters | verify-parameters |
Expand Down

0 comments on commit 382d5e1

Please sign in to comment.