From bd8df38ecd63727c21a94ce1b126ece40e4ceee3 Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Fri, 23 Nov 2018 23:54:54 -0700 Subject: [PATCH] Docs for RootExampleGroup --- src/spectator/root_example_group.cr | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/spectator/root_example_group.cr b/src/spectator/root_example_group.cr index 43f2c10..c2c8566 100644 --- a/src/spectator/root_example_group.cr +++ b/src/spectator/root_example_group.cr @@ -1,11 +1,17 @@ require "./example_group" module Spectator + # Top-most group of examples and sub-groups. + # The root has no parent. class RootExampleGroup < ExampleGroup + # Dummy value - this should never be used. def what : String "ROOT" end + # Does nothing. + # This prevents the root group + # from showing up in output. def to_s(io) # ... end