From 72916cf4df5b8f2dc347317ae25cb1324ccbe4c0 Mon Sep 17 00:00:00 2001 From: Patrick Mylund Nielsen Date: Fri, 17 Aug 2012 13:48:55 +0200 Subject: [PATCH] Update README to reflect API change: IncrementFloat now only works on float32 and float64, and the use of Decrement should be encouraged over Increment (with a negative number) since Increment converting a negative signed integer to an unsigned integer probably isn't the intended behavior --- README | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README b/README index 5554212..e5a43bc 100644 --- a/README +++ b/README @@ -119,15 +119,13 @@ func (c *Cache) Increment(k string, n int64) error Increment an item of type int, int8, int16, int32, int64, uintptr, uint, uint8, uint32, or uint64, float32 or float64 by n. Returns an error if the item's value is not an integer, if it was not found, or if it is not - possible to increment it by n. Passing a negative number will cause the item - to be decremented. + possible to increment it by n. func (c *Cache) IncrementFloat(k string, n float64) error - Increment an item of type int, int8, int16, int32, int64, uintptr, uint, - uint8, uint32, or uint64, float32 or float64 by n. Returns an error if the - item's value is not an integer, if it was not found, or if it is not - possible to increment it by n. Passing a negative number will cause the item - to be decremented. + Increment an item of type float32 or float64 by n. Returns an error if the + item's value is not floating point, if it was not found, or if it is not + possible to increment it by n. Pass a negative number to decrement the + value. func (c *Cache) Decrement(k string, n int64) error Decrement an item of type int, int8, int16, int32, int64, uintptr, uint,