Bug 13194 - Tiny typo in POD for SetMessagingPreferencesFromDefaults
Summary: Tiny typo in POD for SetMessagingPreferencesFromDefaults
Status: CLOSED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: Architecture, internals, and plumbing (show other bugs)
Version: Main
Hardware: All All
: P5 - low trivial (vote)
Assignee: Magnus Enger
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-11-04 11:44 UTC by Magnus Enger
Modified: 2015-06-04 23:32 UTC (History)
1 user (show)

See Also:
Change sponsored?: ---
Patch complexity: Trivial patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Attachments
Fix typo in SetMessagingPreferencesFromDefaults POD (1.32 KB, patch)
2014-11-04 13:09 UTC, Magnus Enger
Details | Diff | Splinter Review
[SIGNED OFF] Bug 13194: Fix typo in SetMessagingPreferencesFromDefaults POD (1.60 KB, patch)
2014-11-05 07:19 UTC, Mark Tompsett
Details | Diff | Splinter Review
Bug 13194: Fix typo in SetMessagingPreferencesFromDefaults POD (1.64 KB, patch)
2014-11-05 15:31 UTC, Jonathan Druart
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Magnus Enger 2014-11-04 11:44:11 UTC
The POD for C4::Members::Messaging::SetMessagingPreferencesFromDefaults() has an example of usage:

  C4::Members::Messaging::SetMessagingPreferenceFromDefaults( { borrowernumber => $borrower->{'borrowernumber'}
                                                                categorycode   => 'CPL' } );

The name of the subroutine is mis-spelled as SetMessagingPreferenceFromDefaults when it should be SetMessagingPreference*s*FromDefaults. 

This has no practical consequences of course, but if you copy and paste the example into your code it can lead to some unnecessary head scratching. Trust me, I know...
Comment 1 Magnus Enger 2014-11-04 13:09:49 UTC Comment hidden (obsolete)
Comment 2 Mark Tompsett 2014-11-05 07:19:38 UTC Comment hidden (obsolete)
Comment 3 Jonathan Druart 2014-11-05 15:31:39 UTC
Created attachment 33250 [details] [review]
Bug 13194: Fix typo in SetMessagingPreferencesFromDefaults POD

The example usage for
C4::Members::Messaging::SetMessagingPreferencesFromDefaults
calls the subroutine SetMessagingPreferenceFromDefaults, not
SetMessagingPreferencesFromDefaults (missing the 's' at the
end of 'Preferences').

To test:
- Apply the patch
- Check that the POD now refers to the actual name of the
  subroutine
  (perldoc C4::Members::Messaging)

Adding 's' is the correct doc change to make it match with
the function definition. Comfirmable with less.
perldoc C4::Members::Messaging proves the doc is still nice.

Signed-off-by: Mark Tompsett <mtompset@hotmail.com>

Signed-off-by: Jonathan Druart <jonathan.druart@biblibre.com>
Comment 4 Tomás Cohen Arazi 2014-11-06 13:27:42 UTC
Patch pushed to master.

Thanks Magnus!