Improve persist_in_session POD formatting
Dagfinn Ilmari Mannsåker [Thu, 11 Feb 2016 17:25:55 +0000 (17:25 +0000)]
README
lib/Catalyst/Authentication/Store/LDAP.pm

diff --git a/README b/README
index 5bafe8e..a495d71 100644 (file)
--- a/README
+++ b/README
@@ -275,19 +275,20 @@ CONFIGURATION OPTIONS
     instead be performed when bound as the user you authenticated as.
 
   persist_in_session
-    Can take one of the following values, defaults to *username*:
+    Can take one of the following values, defaults to "username":
 
-   username
-    Only store the username in the session and lookup the user and its roles
-    on every request. That was how the module worked until version 1.015 and
-    is also the default for backwards compatibility.
+    "username"
+        Only store the username in the session and lookup the user and its
+        roles on every request. That was how the module worked until version
+        1.015 and is also the default for backwards compatibility.
 
-   all
-    Store the user object and its roles in the session and never look it up
-    in the store after login.
+    "all"
+        Store the user object and its roles in the session and never look it
+        up in the store after login.
 
-    NOTE: It's recommended to limit the user attributes fetched from LDAP
-    using user_search_options / attrs to not exhaust the session store..
+        NOTE: It's recommended to limit the user attributes fetched from
+        LDAP using user_search_options / attrs to not exhaust the session
+        store.
 
   entry_class
     The name of the class of LDAP entries returned. This class should exist
index 9c13bde..196f180 100644 (file)
@@ -318,21 +318,25 @@ performed when bound as the user you authenticated as.
 
 =head2 persist_in_session
 
-Can take one of the following values, defaults to I<username>:
+Can take one of the following values, defaults to C<username>:
 
-=head3 username
+=over
+
+=item C<username>
 
 Only store the username in the session and lookup the user and its roles
 on every request. That was how the module worked until version 1.015 and is
 also the default for backwards compatibility.
 
-=head3 all
+=item C<all>
 
 Store the user object and its roles in the session and never look it up in
 the store after login.
 
 B<NOTE:> It's recommended to limit the user attributes fetched from LDAP
-using L<user_search_options> / attrs to not exhaust the session store..
+using L<user_search_options> / attrs to not exhaust the session store.
+
+=back
 
 =head2 entry_class