documentation fixes

7 files changed, 19 insertions, 15 deletions

diff --git a/Changes b/Changes
index 882bfb8..bf3a551 100644
--- a/Changes
+++ b/Changes
@@ -1,4 +1,5 @@
 {{$NEXT}}
+ - documentation fixes
 
 1.1.0     2023-02-28 11:56:27+00:00 Europe/London
  - require perl 5.36
diff --git a/lib/Sietima.pm b/lib/Sietima.pm
index 32b2227..52473f9 100644
--- a/lib/Sietima.pm
+++ b/lib/Sietima.pm
@@ -54,6 +54,8 @@ adds C<List-*> headers to all outgoing messages
 specifies that to (un)subscribe, people should write to the list owner
 = L<< C<NoMail>|Sietima::Role::NoMail >>
 avoids sending messages to subscribers who don't want them
+= L<< C<NoSpoof>|Sietima::Role::NoSpoof >>
+replaces the C<From> address with the list's own address
 = L<< C<ReplyTo>|Sietima::Role::ReplyTo >>
 optionally sets the C<Reply-To> header to the mailing list address
 = L<< C<SubjectTag>|Sietima::Role::SubjectTag >>
@@ -95,7 +97,7 @@ empty array.
 Each item can be coerced from a string or a L<< C<Email::Address> >>
 instance, or a hashref of the form
 
-  { address => $string, %other_attributes }
+  { primary => $string, %other_attributes }
 
 The base Sietima class only uses the address of subscribers, but some
 roles use the other attributes (L<< C<NoMail>|Sietima::Role::NoMail
diff --git a/lib/Sietima/MailStore.pm b/lib/Sietima/MailStore.pm
index 5e6fc7f..d29b3b6 100644
--- a/lib/Sietima/MailStore.pm
+++ b/lib/Sietima/MailStore.pm
@@ -66,7 +66,7 @@ return an arrayref of hashrefs. For example:
  my $id2 = $ms->store($msg2,'t2');
  my $id3 = $ms->store($msg3,'t1','t2');
 
- $ms->retrieve_ids_by_tags('t1') ==> [
+ $ms->retrieve_by_tags('t1') ==> [
    { id => $id3, mail => $msg3 },
    { id => $id1, mail => $msg1 },
   ]
diff --git a/lib/Sietima/MailStore/FS.pm b/lib/Sietima/MailStore/FS.pm
index 9a77c3c..060e321 100644
--- a/lib/Sietima/MailStore/FS.pm
+++ b/lib/Sietima/MailStore/FS.pm
@@ -64,7 +64,7 @@ sub BUILD($self,@) {
   my $id = $store->store($email_mime_object,@tags);
 
 Stores the given email message inside the L<store root|/root>, and
-associates with the given tags.
+associates it with the given tags.
 
 Returns a unique identifier for the stored message. If you store twice
 the same message (or two messages that stringify identically), you'll
@@ -169,7 +169,7 @@ sub retrieve_ids_by_tags($self,$tags) {
 This method is similar to L<< /C<retrieve_ids_by_tags> >>, but it
 returns an arrayref of hashrefs like:
 
- $store->retrieve_ids_by_tags('t1') ==> [
+ $store->retrieve_by_tags('t1') ==> [
    { id => $id1, mail => $msg1 },
    { id => $id2, mail => $msg2 },
   ]
@@ -223,7 +223,6 @@ sub remove($self,$id) {
 This method removes all messages from disk. Clearing as empty store
 does nothing.
 
-
 =cut
 
 sub clear($self) {
diff --git a/lib/Sietima/Policy.pm b/lib/Sietima/Policy.pm
index a2c1dcf..130cb44 100644
--- a/lib/Sietima/Policy.pm
+++ b/lib/Sietima/Policy.pm
@@ -9,11 +9,10 @@ use feature ':5.36';
 
 =head1 SYNOPSIS
 
-  use 5.024;
+  use v5.36;
   use strict;
   use warnings;
-  use feature ':5.24';
-  use experimental 'signatures';
+  use feature ':5.36';
 
 or just:
 
diff --git a/lib/Sietima/Role/SubscriberOnly.pm b/lib/Sietima/Role/SubscriberOnly.pm
index bf845f7..112f85f 100644
--- a/lib/Sietima/Role/SubscriberOnly.pm
+++ b/lib/Sietima/Role/SubscriberOnly.pm
@@ -36,9 +36,10 @@ C<Sietima::Role::SubscriberOnly::Moderate> >> for useable roles.
 This method will be invoked from L<< C<munge_mail>|Sietima/munge_mail
 >> whenever an email is processed that does not come from one of the
 list's subscribers. This method should return a (possibly empty) list
-of L<< C<Sietima::Message> >> objects, just like C<munge_mail>. It can
-also have side-effects, like forwarding the email to the owner of the
-list.
+of L<< C<Sietima::Message> >> objects, just like C<munge_mail>, for
+example to forward the email to the owner of the list. It can also
+have side-effects, like storing a copy of the message to approve
+later.
 
 =cut
 
diff --git a/lib/Sietima/Role/SubscriberOnly/Moderate.pm b/lib/Sietima/Role/SubscriberOnly/Moderate.pm
index ee8d0c6..b4d144c 100644
--- a/lib/Sietima/Role/SubscriberOnly/Moderate.pm
+++ b/lib/Sietima/Role/SubscriberOnly/Moderate.pm
@@ -70,8 +70,9 @@ sub munge_mail_from_non_subscriber ($self,$mail) {
 
   $sietima->resume($mail_id);
 
-Given an identifier returned when L<storing|Sietima::MailStore/store>
-an email, this method retrieves the email and re-processes it via L<<
+Given the identifier returned when
+L<storing|Sietima::MailStore/store>-ing an email, this method
+retrieves the email and re-processes it via L<<
 C<ignoring_subscriberonly>|Sietima::Role::SubscriberOnly/ignoring_subscriberonly
 >>. This will make sure that the email is not caught again by the
 subscriber-only filter.
@@ -90,8 +91,9 @@ sub resume ($self,$mail_id) {
 
   $sietima->drop($mail_id);
 
-Given an identifier returned when L<storing|Sietima::MailStore/store>
-an email, this method deletes the email from the store.
+Given the identifier returned when
+L<storing|Sietima::MailStore/store>-ing an email, this method deletes
+the email from the store.
 
 =cut