Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

extend readme to highlight special cases around parsing and printing when using trailing zeros #277

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Arbitrary-precision fixed-point decimal numbers in go.

_Note:_ Decimal library can "only" represent numbers with a maximum of 2^31 digits after the decimal point.

_Note:_ The library does not remove trailing zeros when parsing decimals from strings, e.g., `1.18` does not internally equal `1.1800` when parsing with this library, see example in usage

## Features

* The zero-value is 0, and is safe to use without initialization
Expand Down Expand Up @@ -57,6 +59,32 @@ func main() {
}
```

Conservation of precision with trailing zeros. This conservation is, however,
not translated backwards when printing the decimal as string.

This is important to know.

```go
package main

import (
"fmt"
"github.com/shopspring/decimal"
)

func main() {
noZeros := "1.18"
trailingZeros := "1.1800"

d1 := decimal.RequireFromString(noZeros)
d2 := decimal.RequireFromString(trailingZeros)

fmt.Println(d1.Coefficient(), d1.Exponent()) // 118 -2
fmt.Println(d2.Coefficient(), d2.Exponent()) // 118 -4
fmt.Println(d1) // 1.18
fmt.Println(d2) // 1.18
```

## Documentation

http://godoc.org/github.com/shopspring/decimal
Expand Down