Checking in changes prior to tagging of version 0.4501. Changelog diff is:
[gitmo/Mouse.git] / lib / Mouse / Spec.pm
index 04fa723..f688eb4 100644 (file)
@@ -2,10 +2,10 @@ package Mouse::Spec;
 use strict;
 use warnings;
 
-our $VERSION = '0.37_05';
+our $VERSION = '0.4501';
 
 our $MouseVersion = $VERSION;
-our $MooseVersion = '0.90';
+our $MooseVersion = '0.93';
 
 sub MouseVersion{ $MouseVersion }
 sub MooseVersion{ $MooseVersion }
@@ -17,8 +17,48 @@ __END__
 
 Mouse::Spec - To what extent Mouse is compatible with Moose
 
+=head1 VERSION
+
+This document describes Mouse version 0.4501
+
+=head1 SYNOPSIS
+
+    use Mouse::Spec;
+
+    printf "Mouse/%s is compatible with Moose/%s\n",
+        Mouse::Spec->MouseVersion, Mouse::Spec->MooseVersion;
+
 =head1 DESCRIPTION
 
+Mouse is a subset of Moose. This document describes to what extend Mouse is
+compatible with Moose.
+
+=head2 Compatibility with Moose
+
+The sugary API is highly compatible with Moose.
+
+=head2 Incompatibility with Moose
+
+=head3 Meta object protocols
+
+Any MOP in Mouse has no attributes.
+
+For this reason, C<< $metaclass->meta->make_immutable() >> does not yet work as you expect.
+B<Don not make metaclasses immutable>.
+
+=head3 Mouse::Meta::Instance
+
+Meta instance mechanism is not implemented.
+
+=head3 Role exclusion
+
+Role exclusion, C<exclude()>, is not implemented.
+
+=head3 -metaclass in Mouse::Exporter
+
+C<< use Mouse -metaclass => ... >> are not implemented.
+Use C<< use Mouse -traits => ... >> instead.
+
 =head2 Notes about Moose::Cookbook
 
 Many recipes in L<Moose::Cookbook> fit L<Mouse>, including:
@@ -95,5 +135,11 @@ L<Moose::Cookbook::Extending::Recipe3> - Providing an alternate base object clas
 
 L<Mouse>
 
+L<Moose>
+
+L<Moose::Manual>
+
+L<Moose::Cookbook>
+
 =cut