Sitelet https://github.com/LukasNiessen/ArchUnitTS/commit/3e27da0119caf0dd565a666dd38e663bd547e79a
Skip to content

Commit 3e27da0

Browse files
committed
Updated README
1 parent fdbeab0 commit 3e27da0

2 files changed

Lines changed: 2 additions & 3 deletions

File tree

‎.github/workflows/docs.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ concurrency:
99
group: 'pages'
1010
cancel-in-progress: true
1111

12-
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
1312
permissions:
1413
contents: read
1514
pages: write

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1052,6 +1052,6 @@ This project is under the **MIT** license.
10521052

10531053
## P.S.
10541054

1055-
### Notes
1055+
### Special Note on Cycle-Free Checks
10561056

1057-
**Special Note on Cycle-Free Checks**: Empty checks are particularly nuanced for cycle-free assertions. Consider this scenario: folder A contains one file that only depends on folder B. When testing `.inFolder("A").should().haveNoCycles()`, we want to check for cycles _within_ folder A only. However, if we report an empty test error, users might be confused since folder A does contain a file. Therefore, cycle-free checks use a more permissive approach and check the unfiltered file set for emptiness, rather than the filtered set that's actually analyzed for cycles.
1057+
Empty checks are particularly nuanced for cycle-free assertions. Consider this scenario: folder A contains one file that only depends on folder B. When testing `.inFolder("A").should().haveNoCycles()`, we want to check for cycles _within_ folder A only. However, if we report an empty test error, users might be confused since folder A does contain a file. Therefore, cycle-free checks use a more permissive approach and check the unfiltered file set for emptiness, rather than the filtered set that's actually analyzed for cycles.

0 commit comments

Comments
 (0)