[gnc-lot.h] amend description for gnc_lot_get_earliest_split

this function doesn't necessarily point to the lot opening split.
This commit is contained in:
Christopher Lam 2019-12-24 16:43:55 +07:00
parent f583bc6d86
commit 8fb73c7ed1

View File

@ -147,9 +147,10 @@ void gnc_lot_get_balance_before (const GNCLot *, const Split *,
gboolean gnc_lot_is_closed (GNCLot *);
/** The gnc_lot_get_earliest_split() routine is a convenience routine
* that helps identify the date this lot was opened. It simply
* that helps identify the earliest date in the lot. It simply
* loops over all of the splits in the lot, and returns the split
* with the earliest split->transaction->date_posted.
* with the earliest split->transaction->date_posted. It may not
* necessarily identify the lot opening split.
*/
Split * gnc_lot_get_earliest_split (GNCLot *lot);