Bug 14538 - POD for CalcFine is incomplete
Summary: POD for CalcFine is incomplete
Status: CLOSED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: Developer documentation (show other bugs)
Version: Main
Hardware: All All
: P5 - low minor (vote)
Assignee: natasha
QA Contact: Testopia
URL:
Keywords: Academy
Depends on:
Blocks:
 
Reported: 2015-07-16 12:55 UTC by Katrin Fischer
Modified: 2017-01-10 19:33 UTC (History)
5 users (show)

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


Attachments
Bug 14538: editing perl doc for CalcFine (1.66 KB, patch)
2016-01-18 23:02 UTC, natasha
Details | Diff | Splinter Review
Bug 14538: editing perl doc for CalcFine (1.78 KB, patch)
2016-01-19 16:23 UTC, Mark Tompsett
Details | Diff | Splinter Review
Bug 14538: editing perl doc for CalcFine (1.85 KB, patch)
2016-01-19 16:33 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 Katrin Fischer 2015-07-16 12:55:53 UTC
From reading the code it looks like CalcFine returns 4 values, while only 3 are documented (missing:chargeable_units). There is also a mismatch in names between the first and second paragraphs ($daycounttotal vs. $unitcount)
Comment 1 natasha 2016-01-18 23:02:28 UTC Comment hidden (obsolete)
Comment 2 Mark Tompsett 2016-01-19 16:23:57 UTC Comment hidden (obsolete)
Comment 3 Jonathan Druart 2016-01-19 16:33:01 UTC
Created attachment 46909 [details] [review]
Bug 14538: editing perl doc for CalcFine

To Test:
Read perldoc C4/Overdues.pm
Confirm that it says CalcFine returns four values and that rest of the documentation is correct

NOTE: only a little visual ugliness, but definitely an improvement.

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

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Comment 4 Jesse Weaver 2016-01-19 22:50:11 UTC
Pushed to master, thanks for your work!
Comment 5 Julian Maurice 2016-01-25 12:21:47 UTC
Patch pushed to 3.22.x, will be in 3.22.2
Comment 6 Frédéric Demians 2016-01-25 16:28:52 UTC
This patch has been pushed to 3.20.x, will be in 3.20.8.