]> Cypherpunks repositories - gostls13.git/commitdiff
scanner: change package comment to be clearer about its functionality.
authorRob Pike <r@golang.org>
Wed, 25 Aug 2010 03:07:08 +0000 (13:07 +1000)
committerRob Pike <r@golang.org>
Wed, 25 Aug 2010 03:07:08 +0000 (13:07 +1000)
No semantic changes.

R=gri, rsc1
CC=golang-dev
https://golang.org/cl/1998045

src/pkg/scanner/scanner.go

index a1aa109cb2490f17399258f1e1e60d9def98f29e..0f864f8ff340c6d792b8b9b42df1add963289f86 100644 (file)
@@ -2,15 +2,15 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// A general-purpose scanner for UTF-8 encoded text. Takes an io.Reader
-// providing the source which then can be tokenized through repeated
-// calls to the Scan function. For compatibility with existing tools,
-// the NUL character is not allowed (implementation restriction).
+// A scanner and tokenizer for UTF-8-encoded text.  Takes an io.Reader
+// providing the source, which then can be tokenized through repeated calls
+// to the Scan function.  For compatibility with existing tools, the NUL
+// character is not allowed (implementation restriction).
 //
-// By default, a Scanner skips white space and comments and
-// recognizes literals as defined by the Go language spec.
-// It may be customized to recognize only a subset of those
-// literals and to recognize different white space characters.
+// By default, a Scanner skips white space and Go comments and recognizes all
+// literals as defined by the Go language specification.  It may be
+// customized to recognize only a subset of those literals and to recognize
+// different white space characters.
 //
 // Basic usage pattern:
 //