summaryrefslogtreecommitdiff
path: root/lib/UNIVERSAL.pm
diff options
context:
space:
mode:
authorJohn Peacock <jpeacock@cpan.org>2011-12-08 20:55:37 -0500
committerDavid Golden <dagolden@cpan.org>2011-12-09 14:59:04 -0500
commita3e88ad7b21876c5341fd043218d0725ec4c4fcb (patch)
tree80477d2f2fac15f39d26fd74b1ad26a976a0d563 /lib/UNIVERSAL.pm
parent249f7ddc6a71afa99cbcae72f08451ee2462c7c5 (diff)
downloadperl-a3e88ad7b21876c5341fd043218d0725ec4c4fcb.tar.gz
Update UNIVERSAL::VERSION POD to reflect reality.
This should have been done when version objects were originally added to the core back in 5.10.0. Mea culpa. [I bumped UNIVERSAL.pm version and added a perldelta entry. -- DG] Signed-off-by: David Golden <dagolden@cpan.org>
Diffstat (limited to 'lib/UNIVERSAL.pm')
-rw-r--r--lib/UNIVERSAL.pm7
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/UNIVERSAL.pm b/lib/UNIVERSAL.pm
index 4e4122362a..1adf09c272 100644
--- a/lib/UNIVERSAL.pm
+++ b/lib/UNIVERSAL.pm
@@ -1,6 +1,6 @@
package UNIVERSAL;
-our $VERSION = '1.10';
+our $VERSION = '1.11';
# UNIVERSAL should not contain any extra subs/methods beyond those
# that it exists to define. The use of Exporter below is a historical
@@ -168,6 +168,11 @@ it will do a comparison and die if the package version is not
greater than or equal to C<REQUIRE>, or if either C<$VERSION> or C<REQUIRE>
is not a "lax" version number (as defined by the L<version> module).
+The return from C<VERSION> will actually be the stringified version object
+using the package C<$VERSION> scalar, which is guaranteed to be equivalent
+but may not be precisely the contents of the C<$VERSION> scalar. If you want
+the actual contents of C<$VERSION>, use C<$CLASS::VERSION> instead.
+
C<VERSION> can be called as either a class (static) method or an object
method.