This commit is contained in:
Michael Miller 2021-03-31 16:07:01 -06:00
parent d612657b15
commit 0b2ea79329
No known key found for this signature in database
GPG key ID: FB9F12F7C646A4AD

View file

@ -20,18 +20,18 @@ module Spectator
# One of those is testing Spectator.
class_property? autorun = true
# All tests are ran just before the executable exits.
# All tests run just before the executable exits.
# Tests will be skipped, however, if `#autorun?` is set to false.
# There are a couple of reasons for this.
#
# First is that we want a clean interface for the end-user.
# They shouldn't need to call a "run" method.
# That adds the burden on the developer to ensure the tests are run after they are created.
# That adds burden on the developer to ensure the tests run after they are created.
# And that gets complicated when there are multiple files that could run in any order.
#
# Second is to allow all of the tests and framework to be constructed.
# We know that all of the instances and DSL builders have finished
# after the main part of the executable has run.
# after the main part of the executable has completed.
#
# By doing this, we provide a clean interface and safely run after everything is constructed.
# The downside, if something bad happens, like an exception is raised,