no kidding sherlock
[catagits/Catalyst-Plugin-Session-State-Stash.git] / lib / Catalyst / Plugin / Session / State / Stash.pm
index d68837b..80f2fe7 100644 (file)
@@ -1,4 +1,6 @@
 package Catalyst::Plugin::Session::State::Stash;
+# ABSTRACT: Maintain session IDs using the stash
+
 use Moose;
 use 5.008;
 use MRO::Compat;
@@ -6,7 +8,7 @@ use namespace::autoclean;
 
 extends 'Catalyst::Plugin::Session::State';
 
-our $VERSION = "0.13";
+our $VERSION = '0.15';
 
 has _deleted_session_id => ( is => 'rw' );
 has _prepared => ( is => 'rw' );
@@ -91,10 +93,6 @@ __END__
 
 =pod
 
-=head1 NAME
-
-Catalyst::Plugin::Session::State::Stash - Maintain session IDs using the stash
-
 =head1 SYNOPSIS
 
  use Catalyst qw/Session Session::State::Stash Session::Store::Foo/;
@@ -157,8 +155,8 @@ The name of the hash key to use. Defaults to C<_session>.
 
 =item stash_delim
 
-If present, splits stash_key at this character to nest. E.g. delim of '/'
-and key of '123/456' will store it as $c->stash->{123}->{456}
+If present, splits C<stash_key> at this character to nest. E.g. a C<delim> of '/'
+and C<stash_key> of '123/456' will store it as $c->stash->{123}->{456}
 
 =item expires
 
@@ -166,7 +164,7 @@ How long the session should last in seconds.
 
 =back
 
-For example, you could stick this in MyApp.pm:
+For example, you could stick this in F<MyApp.pm>:
 
   __PACKAGE__->config( 'Plugin::Session' => {
      stash_key  => 'session_id',
@@ -175,12 +173,9 @@ For example, you could stick this in MyApp.pm:
 =head1 BUGS
 
 You can't delete a session then create a new one. If this is important to you,
-patches welcome. It is not important to me and fixing this for completeness
-is pretty low on my list of priorities.
-
-=head1 CAVEATS
+patches welcome!
 
-Manual work may be involved to make better use of this.
+=for stopwords stateful
 
 If you are writing a stateful web service with
 L<Catalyst::Plugin::Server::XMLRPC>, you will probably only have to deal with
@@ -191,22 +186,15 @@ loading, as when saving, the ID will already be on the stash.
 L<Catalyst>, L<Catalyst::Plugin::Session>, L<Catalyst::Plugin::Session::State>,
 L<Catalyst::Plugin::Session::State::Cookie> (what you probably want).
 
-=head1 AUTHORS
-
-James Laver E<lt>perl -e 'printf qw/%s@%s.com cpan jameslaver/'E<gt>
-
 =head1 CONTRIBUTORS
 
-This module is derived from L<Catalyst::Plugin::Session::State::Cookie> code.
+=begin :list
 
-Thanks to anyone who wrote code for that.
+* This module is derived from L<Catalyst::Plugin::Session::State::Cookie> code.
+  Thanks to anyone who wrote code for that.
 
-Thanks to Kent Fredric for a patch for nested keys
+* Thanks to Kent Fredric for a patch for nested keys
 
-=head1 COPYRIGHT
-
-This program is free software, you can redistribute it and/or modify it
-under the same terms as Perl itself.
+=end :list
 
 =cut
-