Skip to content

docs: set the examples in an abstract art gallery - #1167

Merged
vbreuss merged 1 commit into
mainfrom
docs/art-gallery-theme
Oct 30, 2026
Merged

vbreuss merged 1 commit into
mainfrom
docs/art-gallery-theme

Conversation

@vbreuss

@vbreuss vbreuss commented Oct 30, 2026

Copy link
Copy Markdown
Member

The other Testably libraries give their documentation a recurring example domain (aweXpect uses music, Mockolate chocolate, Awaiten a coffee shop), while the Abstractions docs used foo, bar, a.txt and MyTests. A shared setting makes the snippets easier to read and remember, and lets the pages build on each other instead of starting from scratch each time. An abstract art gallery fits naturally: it has files (catalogs, artworks, a vault), time (opening hours, exhibitions that close, night patrols) and randomness (the artwork of the day, archive numbers).

Changes

  • New page "A complete example" (between "Random system" and "Companion libraries"): an ExhibitionArchiver that moves a closed exhibition into the vault under a random archive number. Its three tests combine all three mocks: the time system decides whether the exhibition has closed, a fixed Guid makes the archive number predictable, and the file system verifies that nothing is touched while the exhibition is open and simulates a full vault with Intercept.
  • Gallery stories on the landing page tabs (CatalogService, Exhibition, ArtworkOfTheDay), Getting Started (which now briefly introduces the setting), the FileSystemWatcher page, the PeriodicTimer page (a NightGuard patrolling every 30 minutes) and Intercept & notify (a full vault).
  • Light renames on the reference pages: placeholder names are replaced by gallery names such as catalog.json, red-square.png, vault/ and provenance.txt. Pages that document exact behaviour (SafeFileHandle, RandomAccess, memory-mapped files) only got new file names, and examples that depend on byte counts keep the same lengths.

aweXpect, Mockolate and Awaiten each tell their examples in one theme, while the Abstractions examples used placeholders like foo.txt and ReportService. A shared gallery domain makes the examples easier to follow and remember, and enables a complete example that combines the file system, time and random system.
@vbreuss vbreuss self-assigned this Oct 30, 2026
@vbreuss vbreuss added the documentation Improvements or additions to documentation label Oct 30, 2026
Copilot AI balanced review requested due to automatic review settings October 30, 2026 05:52

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

@github-actions

Copy link
Copy Markdown

Test Results

     62 files  ±0       62 suites  ±0   1h 13m 41s ⏱️ - 4m 4s
 66 189 tests  - 3   62 677 ✅  - 3   3 512 💤 ±0  0 ❌ ±0 
151 386 runs  ±0  136 616 ✅ ±0  14 770 💤 ±0  0 ❌ ±0 

Results for commit 14b26c1. ± Comparison against base commit 54bda97.

This pull request removes 63019 and adds 63015 tests. Note that renamed tests count towards both.
  )
)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(13e0be49-9b92-4bb4-a200-8adf60c7f7a4)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(33e85d28-734d-46c5-96fc-bb41f91dbd1e)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(36098327-8157-47ce-9308-8028b2577d4d)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(3fab2573-9362-4d9b-a9a8-fe46a1bc590b)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(402a991c-af5e-448c-80dc-74800742fa6f)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(5f24b8c0-2347-4efc-b608-da1b5573b6af)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(7c981633-7518-45c1-86a6-c5fd9eaaa367)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(8334a0ee-d7bc-43d4-bf34-cd4b70faa456)
…
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(0826b1e5-d190-451b-82f0-b98bed44382a)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(1a133ec5-ac07-4f0d-b3ba-9783b419c140)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(1acce60e-5a15-49ae-b50c-5399e608efa2)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(20249ab7-4d2c-47b9-bb3e-0a417a7f84a7)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(2350184e-ec02-4817-b5a7-8db3ff1fbeee)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(6204d17e-bfa5-4a9b-ae26-75154c273e05)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(63978c21-6e85-4c24-bd7a-c7bcf77d137e)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(63fcfc24-2c99-43f0-97f8-c441699f1a4b)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(6d16c68f-edb6-4b25-8ab8-f2f193701215)
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests ‑ SetAccessControl_ShouldNotUpdateTimes(89450a45-38aa-43d0-ba87-1b7fa94e7614)
…
This pull request removes 3484 skipped tests and adds 3484 skipped tests. Note that renamed tests count towards both.
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ GetUnixFileMode_SafeFileHandle_ShouldThrowPlatformNotSupportedExceptionOnWindows(07937805-51f5-4d71-9040-97668a7883e2)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ GetUnixFileMode_SafeFileHandle_ShouldThrowPlatformNotSupportedExceptionOnWindows(0a44fe68-18ea-46ff-b0c1-3673fa32be23)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ GetUnixFileMode_SafeFileHandle_ShouldThrowPlatformNotSupportedExceptionOnWindows(405ea5f7-a330-4083-a00c-833f90f59bae)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ GetUnixFileMode_SafeFileHandle_ShouldThrowPlatformNotSupportedExceptionOnWindows(49066dba-0521-459c-b184-4095a14ce5b8)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ GetUnixFileMode_SafeFileHandle_ShouldThrowPlatformNotSupportedExceptionOnWindows(a27a19f9-2bfd-4b13-85d2-ac052031b7ad)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ GetUnixFileMode_SafeFileHandle_ShouldThrowPlatformNotSupportedExceptionOnWindows(cf3d89c4-5d0c-4ee9-880c-ecba25a3e8e6)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ SetUnixFileMode_SafeFileHandle_ShouldUpdateValue(4588a573-c41e-439a-a982-03135851659c, None)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ SetUnixFileMode_SafeFileHandle_ShouldUpdateValue(6d746fef-5af8-4974-a76c-f26e4512bf5f, None)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ SetUnixFileMode_SafeFileHandle_ShouldUpdateValue(a13889e2-0c50-460f-b328-be876f7967d7, None)
Testably.Abstractions.Testing.Tests.FileSystem.FileStreamFactoryMockTests ‑ New_ShouldSetUnixFileMode(Append, 1154984b-f47a-47c9-87b8-36152d44359a)
…
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ GetUnixFileMode_SafeFileHandle_ShouldThrowPlatformNotSupportedExceptionOnWindows(40bf6024-0433-492b-8ac1-299ee91ddce5)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ GetUnixFileMode_SafeFileHandle_ShouldThrowPlatformNotSupportedExceptionOnWindows(44fdfa8b-25cd-4b37-ae59-3cb42110575d)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ GetUnixFileMode_SafeFileHandle_ShouldThrowPlatformNotSupportedExceptionOnWindows(760922e5-a1ce-4029-af41-ebdb9a8aba34)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ GetUnixFileMode_SafeFileHandle_ShouldThrowPlatformNotSupportedExceptionOnWindows(a148a331-391c-4aa7-9b92-0cbe013d91a6)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ GetUnixFileMode_SafeFileHandle_ShouldThrowPlatformNotSupportedExceptionOnWindows(a2803ef3-c7a4-45dc-9e2d-3b9ad7b9525c)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ GetUnixFileMode_SafeFileHandle_ShouldThrowPlatformNotSupportedExceptionOnWindows(daa7f24d-7468-423b-b15e-6817e97d17c1)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ SetUnixFileMode_SafeFileHandle_ShouldUpdateValue(095a99d7-6a94-4fc2-8ca8-590bcbfbe381, None)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ SetUnixFileMode_SafeFileHandle_ShouldUpdateValue(19e3561c-0c7e-44c1-bec8-a3d060c08531, None)
Testably.Abstractions.Testing.Tests.FileSystem.FileMockTests ‑ SetUnixFileMode_SafeFileHandle_ShouldUpdateValue(1bd8de45-66e6-42b8-9dd3-f76ef9faa4aa, None)
Testably.Abstractions.Testing.Tests.FileSystem.FileStreamFactoryMockTests ‑ New_ShouldSetUnixFileMode(Append, 5417639a-4e90-42b9-9032-bc949c621765)
…

@mergify

mergify Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

This pull request does not currently match the merge queue conditions, so it cannot be queued from here. The box comes back if it matches again.

@sonarqubecloud

Copy link
Copy Markdown

@vbreuss
vbreuss merged commit a856b45 into main Oct 30, 2026
14 checks passed
@vbreuss
vbreuss deleted the docs/art-gallery-theme branch October 30, 2026 06:45
@github-actions

Copy link
Copy Markdown

This is addressed in release v7.2.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation state: released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants