| Subject: | [PATCH]improve documentation on acronym input |
I found the module very confusing to use with regards to dealing with abbreviations, so I'm contributing documentation for the relevant methods. This is not an actual patch, but here are the relevant sections I've rewritten:
=item add_acronyms( @acronyms )
This function is used for adding acronyms not supported by this code.
The input should be regular expressions for matching the desired acronyms,
but should not include the final period (C<.>). So, for example, C<blv?d>
matches C<blvd.> and C<bld.>. C<a\.mlf> will match C<a.mlf.>. You do not
need to bother with acronyms consisting of single letters and dots
(e.g. "U.S.A."), as these are found automatically. Note also that acronyms
are searched for on a case insensitive basis.
Please see`Acronym/Abbreviations list' section for the abbreviations already
supported by this module.
...
=item set_acronyms( @my_acronyms )
This function replaces the predefined acronym list with the given list. See
L</add_acronyms> for details on the input specifications.