Browse Source

revise docs

speter 13 years ago
parent
commit
e7e3eaa735
2 changed files with 16 additions and 16 deletions
  1. 9 9
      dec.go
  2. 7 7
      rounder.go

+ 9 - 9
dec.go

@@ -24,16 +24,16 @@
 //
 // Compared to http://code.google.com/p/godec , the following APIs have changed:
 //
-//  godec              inf.Dec                 rationale
+//  godec             inf.Dec              rationale
 //  ---------------------------------------------------------------------------
-//  NewDecInt64(u)     NewDec(u, 0)            favor common case for short API
-//  NewDec(u, s)       NewDecBig(b, i)         favor common case for short API
-//  z.SetUnscaled(u)   z.SetUnscaledBig(u)     favor common case for short API
-//  (n/a)              z.SetUnscaled(u)        favor common case for short API
-//  x.Unscaled()       x.UnscaledBig()         favor common case for short API
-//  (n/a)              x.Unscaled()            favor common case for short API
-//  z.Quo(x, y, s, r)  z.QuoRound(x, y, s, r)  consistency (combined operation)
-//  type Scaler        (unexported)            hide implementation details
+//  NewDecInt64(u)    NewDec(u,0)          favor common case for short API
+//  NewDec(u,s)       NewDecBig(b,i)       favor common case for short API
+//  z.SetUnscaled(u)  z.SetUnscaledBig(u)  favor common case for short API
+//  (n/a)             z.SetUnscaled(u)     favor common case for short API
+//  x.Unscaled()      x.UnscaledBig()      consistency (NewDec*/SetUnscaled*)
+//  (n/a)             x.Unscaled()         consistency (NewDec*/SetUnscaled*)
+//  z.Quo(x,y,s,r)    z.QuoRound(x,y,s,r)  consistency (combined operation)
+//  type Scaler       (unexported)         hide implementation details
 //
 package inf
 

+ 7 - 7
rounder.go

@@ -55,7 +55,7 @@ var RoundExact Rounder = roundExact
 // absolute value not exceeding that of the result represented by quo and rem.
 //
 // The following table shows examples of the results for
-// Quo(x, y, scale, RoundDown).
+// QuoRound(x, y, scale, RoundDown).
 //
 //      x      y    scale   result
 //  ------------------------------
@@ -82,7 +82,7 @@ var RoundDown Rounder = roundDown
 // rem.
 //
 // The following table shows examples of the results for
-// Quo(x, y, scale, RoundUp).
+// QuoRound(x, y, scale, RoundUp).
 //
 //      x      y    scale   result
 //  ------------------------------
@@ -108,7 +108,7 @@ var RoundUp Rounder = roundUp
 // rounds to the Dec with the lower absolute value.
 //
 // The following table shows examples of the results for
-// Quo(x, y, scale, RoundHalfDown).
+// QuoRound(x, y, scale, RoundHalfDown).
 //
 //      x      y    scale   result
 //  ------------------------------
@@ -134,7 +134,7 @@ var RoundHalfDown Rounder = roundHalfDown
 // rounds to the Dec with the greater absolute value.
 //
 // The following table shows examples of the results for
-// Quo(x, y, scale, RoundHalfUp).
+// QuoRound(x, y, scale, RoundHalfUp).
 //
 //      x      y    scale   result
 //  ------------------------------
@@ -160,7 +160,7 @@ var RoundHalfUp Rounder = roundHalfUp
 // rounds to the Dec with even last digit.
 //
 // The following table shows examples of the results for
-// Quo(x, y, scale, RoundHalfEven).
+// QuoRound(x, y, scale, RoundHalfEven).
 //
 //      x      y    scale   result
 //  ------------------------------
@@ -186,7 +186,7 @@ var RoundHalfEven Rounder = roundHalfEven
 // Dec not exceeding the result represented by quo and rem.
 //
 // The following table shows examples of the results for
-// Quo(x, y, scale, RoundFloor).
+// QuoRound(x, y, scale, RoundFloor).
 //
 //      x      y    scale   result
 //  ------------------------------
@@ -212,7 +212,7 @@ var RoundFloor Rounder = roundFloor
 // smallest Dec not smaller than the result represented by quo and rem.
 //
 // The following table shows examples of the results for
-// Quo(x, y, scale, RoundCeil).
+// QuoRound(x, y, scale, RoundCeil).
 //
 //      x      y    scale   result
 //  ------------------------------