| Summary: | Tiny typo in POD for SetMessagingPreferencesFromDefaults | ||
|---|---|---|---|
| Product: | Koha | Reporter: | Magnus Enger <magnus> |
| Component: | Architecture, internals, and plumbing | Assignee: | Magnus Enger <magnus> |
| Status: | CLOSED FIXED | QA Contact: | Testopia <testopia> |
| Severity: | trivial | ||
| Priority: | P5 - low | CC: | tomascohen |
| Version: | Main | ||
| Hardware: | All | ||
| OS: | All | ||
| GIT URL: | Initiative type: | --- | |
| Sponsorship status: | --- | Comma delimited list of Sponsors: | |
| Crowdfunding goal: | 0 | Patch complexity: | Trivial patch |
| Documentation contact: | Documentation submission: | ||
| Text to go in the release notes: | Version(s) released in: | ||
| Circulation function: | |||
| Attachments: |
Fix typo in SetMessagingPreferencesFromDefaults POD
[SIGNED OFF] Bug 13194: Fix typo in SetMessagingPreferencesFromDefaults POD Bug 13194: Fix typo in SetMessagingPreferencesFromDefaults POD |
||
Created attachment 33195 [details] [review] 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 Created attachment 33221 [details] [review] [SIGNED OFF] 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) http://bugs.koha-community.org/show_bug.cgi?id=13194 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> 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> Patch pushed to master. Thanks Magnus! |
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...