Note about docs in macros

This commit is contained in:
Michael Miller 2020-09-12 15:59:45 -06:00
parent b271028c1e
commit 1d32946760
No known key found for this signature in database
GPG key ID: FB9F12F7C646A4AD

View file

@ -2,6 +2,10 @@ require "./dsl/*"
module Spectator
# Namespace containing methods representing the spec domain specific language.
#
# Note: Documentation inside macros is kept to a minimuum to reduce generated code.
# This also helps keep error traces small.
# Documentation only useful for debugging is included in generated code.
module DSL
end
end