document X::Signature::NameClash

lib/X/Signature/NameClash.pod

@@ -0,0 +1,27 @@
+=begin pod
+
+=TITLE class X::Signature::NameClash
+
+    my class X::Signature::NameClash does X::Comp { }
+
+Compile time error thrown when two named parameters have the same name,
+potentially through aliases.
+
+For example
+
+    sub f(:$a, :a(:@b)) { }
+
+dies with
+
+    ===SORRY!===
+    Name a used for more than one named parameter
+
+=head1 Methods
+
+=head2 name
+
+    method name() returns Str:D
+
+Returns the name that was used for more than one parameter.
+
+=end pod