From 1d329467600ef2464e30e593c0f0341e45a6df2f Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Sat, 12 Sep 2020 15:59:45 -0600 Subject: [PATCH] Note about docs in macros --- src/spectator/dsl.cr | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/spectator/dsl.cr b/src/spectator/dsl.cr index 0d13112..6a98e85 100644 --- a/src/spectator/dsl.cr +++ b/src/spectator/dsl.cr @@ -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