Rename LT::Set::Mutable to ::Container

[perl/modules/LaTeX-TikZ.git] / lib / LaTeX / TikZ / Set / Container.pm

diff --git a/lib/LaTeX/TikZ/Set/Mutable.pm b/lib/LaTeX/TikZ/Set/Container.pm
similarity index 70%
rename from lib/LaTeX/TikZ/Set/Mutable.pm
rename to lib/LaTeX/TikZ/Set/Container.pm
index e7518cd55f71e8d56ce85558723634ad61ca2be0..37a56cd42085cc3f30ebeb279a29e135ac052771 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Mutable.pm
+++ b/lib/LaTeX/TikZ/Set/Container.pm
@@ -1,11 +1,11 @@
-package LaTeX::TikZ::Set::Mutable;
+package LaTeX::TikZ::Set::Container;
 
 use strict;
 use warnings;
 
 =head1 NAME
 
-LaTeX::TikZ::Set::Mutable - A role for set objects that can be appended to.
+LaTeX::TikZ::Set::Container - A role for set objects that are made of subobjects.
 
 =head1 VERSION
 
@@ -13,8 +13,20 @@ Version 0.02
 
 =head1 DESCRIPTION
 
-L<LaTeX::TikZ::Set> objects that are mutable consume this role.
-This forces them to implement an C<add> method describing how more elements can be added to the set.
+L<LaTeX::TikZ::Set> objects that group other objects together consume this role.
+This forces them to implement :
+
+=over 4
+
+=item *
+
+a C<kids> method that returns the list of subobjects ;
+
+=item *
+
+an C<add> method describing how more elements can be added to the set.
+
+=back
 
 =cut
 
@@ -38,6 +50,7 @@ C<add>
 
 requires qw<
  add
+ kids
 >;
 
 =head1 SEE ALSO
@@ -69,4 +82,4 @@ This program is free software; you can redistribute it and/or modify it under th
 
 =cut
 
-1; # End of LaTeX::TikZ::Set::Mutable
+1; # End of LaTeX::TikZ::Set::Container