Repository navigation
docs: set the examples in an abstract art gallery - #1167
Merged
Merged
Conversation
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.
Test Results 62 files ±0 62 suites ±0 1h 13m 41s ⏱️ - 4m 4s 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.This pull request removes 3484 skipped tests and adds 3484 skipped tests. Note that renamed tests count towards both. |
|
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. |
|
|
This is addressed in release v7.2.0. |
This was referenced Oct 30, 2026
This was referenced Nov 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



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.txtandMyTests. 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
ExhibitionArchiverthat 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 fixedGuidmakes the archive number predictable, and the file system verifies that nothing is touched while the exhibition is open and simulates a full vault withIntercept.CatalogService,Exhibition,ArtworkOfTheDay), Getting Started (which now briefly introduces the setting), the FileSystemWatcher page, the PeriodicTimer page (aNightGuardpatrolling every 30 minutes) and Intercept & notify (a full vault).catalog.json,red-square.png,vault/andprovenance.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.