r23581 - gnucash/trunk/src/engine - Rewrite apparently confusing comment.

[Geert Janssens]

On Thursday 19 December 2013 19:44:19 John Ralls wrote:
> Author: jralls
> Date: 2013-12-19 19:44:18 -0500 (Thu, 19 Dec 2013)
> New Revision: 23581
> Trac: http://svn.gnucash.org/trac/changeset/23581
> 
> Modified:
>    gnucash/trunk/src/engine/gnc-pricedb.c
> Log:
> Rewrite apparently confusing comment.
> 
> Modified: gnucash/trunk/src/engine/gnc-pricedb.c
> 
==========================================================
=========
> --- gnucash/trunk/src/engine/gnc-pricedb.c	2013-12-19 20:30:47 UTC
> (rev 23580) +++ gnucash/trunk/src/engine/gnc-pricedb.c	2013-12-20
> 00:44:18 UTC (rev 23581) @@ -1043,8 +1043,10 @@
>      return TRUE;
>  }
> 
> -/* the gnc_pricedb_add_price() function will use p, adding a ref, so
> -   treat p as read-only if this function succeeds. (Huh ???) */
> +/* If gnc_pricedb_add_price() succeeds, it takes ownership of the
> +   passed-in GNCPrice and inserts it into the pricedb. Writing to
> this +   pointer afterwards will have interesting results, so don't.
> + */
>  gboolean
>  gnc_pricedb_add_price(GNCPriceDB *db, GNCPrice *p)
>  {
> 
John, I do like your dry sense of humor ;)

Geert