Permalink
Browse files

Remove some duplicate POD. Explain fatal a bit more

  • Loading branch information...
1 parent 5afcdfc commit 501d25985abd4f54be17f3dc0e793e27a3269157 Ovid committed Feb 21, 2013
Showing with 12 additions and 18 deletions.
  1. +6 −9 README.md
  2. +6 −9 lib/Unknown/Values.pm
View
15 README.md
@@ -32,6 +32,10 @@ Or:
if ( 3 < $value ) { ... } # fatal error
+ if ( is_unknown $value ) { # not a fatal error
+ ...
+ }
+
# DESCRIPTION
This code is alpha. Some behavior may change. The module name may change.
@@ -89,14 +93,6 @@ they compare to other values. Now replace the above with `undef`:
In other words, you're probably getting garbage.
-# NAME
-
-Unknown::Values - Use 'unknown' values instead of undef ones
-
-# VERSION
-
-version 0.004
-
# EXPORTS
## `unknown`
@@ -203,7 +199,8 @@ equality is fatal.
# ILLEGAL OPERATIONS
Attempting to use `unknown` values in ways that don't make sense is a fatal
-error.
+error (unless you specified `use Unknown::Values 'fatal'`, in which case,
+using `unknown` values in _any_ way other than with `is_unknown` is fatal).
my $value1;
$value1 += 1; # results in 1
View
15 lib/Unknown/Values.pm
@@ -38,14 +38,6 @@ sub is_unknown(_) {
=pod
-=head1 NAME
-
-Unknown::Values - Use 'unknown' values instead of undef ones
-
-=head1 VERSION
-
-version 0.004
-
=head1 SYNOPSIS
use Unknown::Values;
@@ -71,6 +63,10 @@ Or:
if ( 3 < $value ) { ... } # fatal error
+ if ( is_unknown $value ) { # not a fatal error
+ ...
+ }
+
=head1 DESCRIPTION
This code is alpha. Some behavior may change. The module name may change.
@@ -245,7 +241,8 @@ equality is fatal.
=head1 ILLEGAL OPERATIONS
Attempting to use C<unknown> values in ways that don't make sense is a fatal
-error.
+error (unless you specified C<< use Unknown::Values 'fatal' >>, in which case,
+using C<unknown> values in I<any> way other than with C<is_unknown> is fatal).
my $value1;
$value1 += 1; # results in 1

0 comments on commit 501d259

Please sign in to comment.