[Koha-bugs] [Bug 34615] New: Fix POD of C4::Circulation::AddReturn

[bugzilla-daemon at bugs.koha-community.org]

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34615

            Bug ID: 34615
           Summary: Fix POD of C4::Circulation::AddReturn
 Change sponsored?: ---
           Product: Koha
           Version: master
          Hardware: All
                OS: All
            Status: NEW
          Severity: minor
          Priority: P5 - low
         Component: Developer documentation
          Assignee: koha-bugs at lists.koha-community.org
          Reporter: magnus at libriotech.no
        QA Contact: testopia at bugs.koha-community.org

Part of the POD currently looks like this: 

    $messages is a reference-to-hash giving feedback on the operation. The
    keys of the hash are:

    "BadBarcode"
        No item with this barcode exists. The value is $barcode.

    "NotIssued"
        The book is not currently on loan. The value is $barcode.

    "withdrawn"
        This book has been withdrawn/cancelled. The value should be ignored.

    "Wrongbranch"
        This book has was returned to the wrong branch. The value is a
        hashref so that "$messages-"{Wrongbranch}->{Wrongbranch}> and
        "$messages-"{Wrongbranch}->{Rightbranch}> contain the branchcode of
        the incorrect and correct return library, respectively.

    "ResFound"
        The item was reserved. The value is a reference-to-hash whose keys
        are fields from the reserves table of the Koha database, and
        "biblioitemnumber". It also has the key "ResFound", whose value is
        either "Waiting", "Reserved", or 0.

    "WasReturned"
        Value 1 if return is successful.

    "NeedsTransfer"
        If AutomaticItemReturn is disabled, return branch is given as value
        of NeedsTransfer.

    "RecallFound"
        This item can fill a recall. The recall object is returned. If the
        recall pickup branch differs from the branch this item is being
        returned at, "RecallNeedsTransfer" is also returned which contains
        this branchcode.

    "TransferredRecall"
        This item has been transferred to this branch to fill a recall. The
        recall object is returned.

When I run a barcode through AddReturn and dump $messages, I get something like
this: 

$VAR1 = {
          'WrongTransferItem' => x,
          'NotIssued' => 'y',
          'WrongTransfer' => 'Z',
          'TransferTrigger' => 'Reserve'
        };

Looks like at least WrongTransferItem, WrongTransfer and TransferTrigger are
undocumented?

-- 
You are receiving this mail because:
You are watching all bug changes.
You are the assignee for the bug.