Skip to content

Commit b64b277

Browse files
Prachi Gauriarprachigauriar
authored andcommitted
Improve docc intro
1 parent f01d622 commit b64b277

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

Sources/DevTesting/Documentation.docc/Documentation.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
# ``DevTesting``
22

3-
A small package package that contains useful additions for writing tests with Swift Testing.
3+
Write repeatable tests with random data and create mock objects with powerful stubbing.
44

55

66
## Overview
77

8-
DevTesting is a small testing package that makes it easy to test with random values and to stub and spy on mock objects.
8+
DevTesting is a small testing package that contains useful additions for writing tests with Swift Testing. Its
9+
functionality is divided into two distinct subsystems: random value generation and stubbing.
10+
11+
The random value generation subsystem includes types and extensions that enable repeatable testing with random data. It
12+
includes ``SeedableRandomNumberGenerator``, which will always produce the same sequence of random numbers given the same
13+
seed. ``RandomValueGenerating`` uses a seedable random number generator to repeatably generate random values in your
14+
automated tests. It captures the seed before every test so that you can re-run failed tests with the exact same random
15+
values. It also includes convenient functions for generating random booleans, numeric types, strings, optionals, UUIDs,
16+
data, URLs, and more.
17+
18+
The stubbing subsystem includes ``Stub`` and ``ThrowingStub``, which make it easy to mock dependencies and verify their
19+
behavior in tests. The system is designed to help you isolate the code under test while maintaining complete control
20+
over how its dependencies behave and providing detailed information about how those dependencies were used.
921

1022

1123
## Topics

0 commit comments

Comments
 (0)