X::Syntax::Variable::Twigil

Author: moritz

lib/X/Syntax/Variable/Twigil.pod

@@ -0,0 +1,33 @@
+=begin pod
+
+=TITLE class X::Syntax::Variable::Twigil
+
+    class X::Syntax::Variable::Twigil does X::Syntax { }
+
+Syntax error thrown when a variable with a twigil is used in an incompatible
+declaration.
+
+For example
+
+    my $!foo
+
+dies with
+
+    ===SORRY!===
+    Cannot use ! twigil on my variable
+
+=head1 Methods
+
+=head2 twigil
+
+    method twigil() returns Str:D
+
+Returns the twigil that was illegally used
+
+=head2 scope
+
+    method scope() returns Str:D
+
+Returns the scope that did not harmonize with the twigil.
+
+=end pod