Browse Source

doc: no guarantees on Dec assignment semantics

speter 13 years ago
parent
commit
eaadeaae10
1 changed files with 7 additions and 2 deletions
  1. 7 2
      dec.go

+ 7 - 2
dec.go

@@ -15,6 +15,7 @@
 //  - conversions to and from float32/64 types
 //  - conversions to and from float32/64 types
 //
 //
 // Features considered for possible addition:
 // Features considered for possible addition:
+//  + simplify API for New*()
 //  + formatting options
 //  + formatting options
 //  + Exp method
 //  + Exp method
 //  + combined operations such as AddRound/MulAdd etc
 //  + combined operations such as AddRound/MulAdd etc
@@ -35,8 +36,8 @@ import (
 // The sign and the coefficient value are handled together as a signed value
 // The sign and the coefficient value are handled together as a signed value
 // and referred to as the unscaled value.
 // and referred to as the unscaled value.
 // (Positive and negative zero values are not distinguished.)
 // (Positive and negative zero values are not distinguished.)
-// Since the exponent is most commonly negative, it is handled in negated form
-// and referred to as scale.
+// Since the exponent is most commonly non-positive, it is handled in negated
+// form and referred to as scale.
 //
 //
 // The mathematical value of a Dec equals:
 // The mathematical value of a Dec equals:
 //
 //
@@ -56,6 +57,10 @@ import (
 //
 //
 // The zero value for a Dec represents the value 0 with scale 0.
 // The zero value for a Dec represents the value 0 with scale 0.
 //
 //
+// Operations are typically performed through the *Dec type.
+// The semantics of the assignment operation "=" for "bare" Dec values is
+// undefined and should not be relied on.
+//
 // Methods are typically of the form:
 // Methods are typically of the form:
 //
 //
 //	func (z *Dec) Op(x, y *Dec) *Dec
 //	func (z *Dec) Op(x, y *Dec) *Dec