| Summary: | C4::Acquisition::SearchOrder POD inconsistent with function | ||
|---|---|---|---|
| Product: | Koha | Reporter: | MJ Ray (software.coop) <mjr> |
| Component: | Developer documentation | Assignee: | Mark Tompsett <mtompset> |
| Status: | CLOSED FIXED | QA Contact: | Marcel de Rooy <m.de.rooy> |
| Severity: | minor | ||
| Priority: | P5 - low | CC: | kyle, m.de.rooy, mtj, mtompset, veron |
| Version: | Main | ||
| Hardware: | All | ||
| OS: | All | ||
| GIT URL: | Initiative type: | --- | |
| Sponsorship status: | Seeking developer | Comma delimited list of Sponsors: | |
| Crowdfunding goal: | 0 | Patch complexity: | Small patch |
| Documentation contact: | Documentation submission: | ||
| Text to go in the release notes: | Version(s) released in: | ||
| Circulation function: | |||
| Attachments: |
Bug 5395: Update C4::Acquisition::SearchOrders POD
[SIGNED OFF] Bug 5395: Update C4::Acquisition::SearchOrders POD Bug 5395: Update C4::Acquisition::SearchOrders POD |
||
I guess I should take a crack then. Still valid? (In reply to Marc Véron from comment #2) > Still valid? Yes. Function has notably changed, but there are still missing parameters in the perldoc. Created attachment 63681 [details] [review] Bug 5395: Update C4::Acquisition::SearchOrders POD Comparing the perldoc to the function: - basketname - basketgroupname - budget_id Were missing. This adds them. Also, a description of ordernumber and search were added, as they are not self-evident by their name alone. There are no code changes, so all tests should pass or fail identically before and after patch. Comment on attachment 63681 [details] [review] Bug 5395: Update C4::Acquisition::SearchOrders POD Review of attachment 63681 [details] [review]: ----------------------------------------------------------------- ::: C4/Acquisition.pm @@ -1656,4 @@ > @results = &SearchOrders({ > ordernumber => $ordernumber, > search => $search, > - biblionumber => $biblionumber, Moved to match the code order of grabbing parameters, to make comparison easier. Created attachment 63717 [details] [review] [SIGNED OFF] Bug 5395: Update C4::Acquisition::SearchOrders POD Comparing the perldoc to the function: - basketname - basketgroupname - budget_id Were missing. This adds them. Also, a description of ordernumber and search were added, as they are not self-evident by their name alone. There are no code changes, so all tests should pass or fail identically before and after patch. Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> Fixed typo basetgroupname (In reply to Katrin Fischer from comment #6) > Fixed typo basetgroupname Thanks. How embarrassing. Created attachment 63739 [details] [review] Bug 5395: Update C4::Acquisition::SearchOrders POD Comparing the perldoc to the function: - basketname - basketgroupname - budget_id Were missing. This adds them. Also, a description of ordernumber and search were added, as they are not self-evident by their name alone. There are no code changes, so all tests should pass or fail identically before and after patch. Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> Fixed typo basetgroupname Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> Pushed to master for 17.05, thanks Mark! This patch has been pushed to 16.11.x and will be in 16.11.09. Pushed to 16.05.x, for 16.05.15 release |
The C4::Acquisition::SearchOrder POD starts @results = &SearchOrder($search, $biblionumber, $complete); The C4::Acquisition::SearchOrder function starts my ($ordernumber, $search, $supplierid, $basket) = @_; Can someone who really understands what it does update the POD, please, or shall I take a crack?