Bug 4823 - small clarification in Plugin documentation
Summary: small clarification in Plugin documentation
Status: RESOLVED FIXED
Alias: None
Product: Spamassassin
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 3.1.0
Hardware: Other other
: P5 normal
Target Milestone: 3.1.5
Assignee: SpamAssassin Developer Mailing List
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-03-10 00:42 UTC by Kjetil T. Homme
Modified: 2006-08-28 21:11 UTC (History)
0 users


Attachment Type Modified Status Actions Submitter/CLA Status
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Kjetil T. Homme 2006-03-10 00:42:59 UTC 
okay, so I'm a newbie, but I couldn't make sense of this

       Note that eval rules are passed the following arguments:

       The plugin object itself
       The "Mail::SpamAssassin::PerMsgStatus" object calling the rule
       standard arguments for the rule type in use
       any and all arguments as specified in the configuration file

it was not obvious to me that this was a list of four items.  furthermore, it
would be useful if the third item had a small explanation, something like

  * standard arguments for the rule type in use, e.g., an array reference
containing the body for 'body' rules, or no argument at all for 'header' rules".

thanks!
Comment 1 Daryl C. W. O'Shea 2006-08-29 04:11:12 UTC 
I added some hyphens to make it look more like a list of items.  Standard
arguments for rule types are already listed in the next section.


[dos@FC5-VPC 3.1]$ svn ci -m "bug 4823: clarify M::SA::Plugin documentation"
Sending        lib/Mail/SpamAssassin/Plugin.pm
Transmitting file data .
Committed revision 437949.

[dos@FC5-VPC trunk]$ svn ci -m "bug 4823: clarify M::SA::Plugin documentation"
Sending        lib/Mail/SpamAssassin/Plugin.pm
Transmitting file data .
Committed revision 437950.