aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Griesemer <gri@golang.org>2015-02-23 10:20:20 -0800
committerRobert Griesemer <gri@golang.org>2015-02-23 18:35:28 +0000
commit96333a7e4841c37d4c70cdab8748f9e69012cf29 (patch)
tree9ef613b2493a3f798b29c250e7dbc23d2fbddf42
parent2b0213d569dcfdd3f82fa7c98fd5fea26b6e3038 (diff)
downloadgo-96333a7e4841c37d4c70cdab8748f9e69012cf29.tar.gz
go-96333a7e4841c37d4c70cdab8748f9e69012cf29.zip
go/token: document that column positions and file offsets are in bytes
Fixes #9948. Change-Id: I7b354fccd5e933eeeb2253a66acec050ebff6e41 Reviewed-on: https://go-review.googlesource.com/5611 Reviewed-by: Alan Donovan <adonovan@google.com>
-rw-r--r--src/go/token/position.go6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/go/token/position.go b/src/go/token/position.go
index 82d90eeb72..17452bb3d5 100644
--- a/src/go/token/position.go
+++ b/src/go/token/position.go
@@ -21,7 +21,7 @@ type Position struct {
Filename string // filename, if any
Offset int // offset, starting at 0
Line int // line number, starting at 1
- Column int // column number, starting at 1 (character count)
+ Column int // column number, starting at 1 (byte count)
}
// IsValid returns true if the position is valid.
@@ -56,8 +56,8 @@ func (pos Position) String() string {
// where base and size are specified when adding the file to the file set via
// AddFile.
//
-// To create the Pos value for a specific source offset, first add
-// the respective file to the current file set (via FileSet.AddFile)
+// To create the Pos value for a specific source offset (measured in bytes),
+// first add the respective file to the current file set using FileSet.AddFile
// and then call File.Pos(offset) for that file. Given a Pos value p
// for a specific file set fset, the corresponding Position value is
// obtained by calling fset.Position(p).