From c0d4576593906e169f367e7c61d94ed37cc782b8 Mon Sep 17 00:00:00 2001 From: Rob Pike Date: Fri, 7 Mar 2014 13:23:50 +1100 Subject: [PATCH] strconv: document value returned by ParseInt when there is an error Documenting existing behavior; new commentary only. Fixes #7105. LGTM=bradfitz R=golang-codereviews, bradfitz CC=golang-codereviews https://golang.org/cl/68840044 --- src/pkg/strconv/atoi.go | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/pkg/strconv/atoi.go b/src/pkg/strconv/atoi.go index 2d0db7155f..cbf0380ec8 100644 --- a/src/pkg/strconv/atoi.go +++ b/src/pkg/strconv/atoi.go @@ -142,9 +142,11 @@ Error: // // The errors that ParseInt returns have concrete type *NumError // and include err.Num = s. If s is empty or contains invalid -// digits, err.Err = ErrSyntax; if the value corresponding -// to s cannot be represented by a signed integer of the -// given size, err.Err = ErrRange. +// digits, err.Err = ErrSyntax and the returned value is 0; +// if the value corresponding to s cannot be represented by a +// signed integer of the given size, err.Err = ErrRange and the +// returned value is the maximum magnitude integer of the +// appropriate bitSize and sign. func ParseInt(s string, base int, bitSize int) (i int64, err error) { const fnParseInt = "ParseInt"