Merge pull request #129 from JuliaTesting/tb/cuda

Features for CUDA.jl conversion

Author: maleadt

Project.toml

@@ -1,7 +1,7 @@
 name = "ParallelTestRunner"
 uuid = "d3525ed8-44d0-4b2c-a655-542cee43accc"
 authors = ["Valentin Churavy <v.churavy@gmail.com>"]
-version = "2.5.1"
+version = "2.6.0"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

docs/src/api.md

@@ -39,6 +39,20 @@ addworkers
 default_njobs
 ```
 
+## Custom Records
+
+Per-test data is captured in an [`AbstractTestRecord`](@ref). The default
+[`TestRecord`](@ref) stores timing and memory statistics; subtypes can wrap it
+to collect additional data (e.g. GPU metrics) by dispatching [`execute`](@ref)
+on the new type and reading the baseline through [`parent`](@ref).
+
+```@docs
+AbstractTestRecord
+TestRecord
+execute
+parent(::ParallelTestRunner.AbstractTestRecord)
+```
+
 ## Internal Types
 
 These are internal types, not subject to semantic versioning contract (could be changed or removed at any point without notice), not intended for consumption by end-users.