Changeset 67d801e in rattail for rattail/batch/purchase.py


Ignore:
Timestamp:
02/28/19 12:42:13 (11 months ago)
Author:
Lance Edgar <ledgar@…>
Branches:
master
Children:
cf512e7
Parents:
396a48e
Message:

Add some basic docs for "product receiving" features

pretty sure more detail is needed, but a decent starting point

File:
1 edited

Legend:

Unmodified
Added
Removed
  • rattail/batch/purchase.py

    r396a48e r67d801e  
    974974                self.enum.PURHASE_BATCH_MODE.get(batch.mode, "unknown ({})".format(batch.mode))))
    975975
     976    def receive_row(self, row, **kwargs):
     977        """
     978        This method is arguably the workhorse of the whole process. Callers
     979        should invoke it as they receive input from the user during the
     980        receiving workflow.
     981
     982        :param row: Reference to the batch row which is to be updated with the
     983           given receiving data.  The row must exist, i.e. this method will not
     984           create a row for you.
     985
     986        .. todo::
     987           ``**kwargs`` can include several things, some of which should
     988           probably be documented...
     989        """
     990        raise NotImplementedError
     991
    976992    def remove_row(self, row):
    977993        """
Note: See TracChangeset for help on using the changeset viewer.