Commit 238274df authored by Robert Griesemer's avatar Robert Griesemer

go/constant: document that Value.String and ExactString return quoted strings

This has always been the case but it was not obvious from the documentation.
The reason for the quoting is that String() may return an abbreviated string,
starting with double-quote (") but ending in ... (w/o a quote). The missing
quote indicates the abbreviation (in contrast to a string ending in ...").

constant.StringVal can be used to obtain the unquoted string of a String Value.

Change-Id: Id0ba45b6ff62b3e024386ba8d907d6b3a4fcb6d7
Reviewed-on: https://go-review.googlesource.com/28576Reviewed-by: default avatarAlan Donovan <adonovan@google.com>
parent bdb3b790
...@@ -43,13 +43,14 @@ type Value interface { ...@@ -43,13 +43,14 @@ type Value interface {
// Kind returns the value kind. // Kind returns the value kind.
Kind() Kind Kind() Kind
// String returns a short, human-readable form of the value. // String returns a short, quoted (human-readable) form of the value.
// For numeric values, the result may be an approximation; // For numeric values, the result may be an approximation;
// for String values the result may be a shortened string. // for String values the result may be a shortened string.
// Use ExactString for a string representing a value exactly. // Use ExactString for a string representing a value exactly.
String() string String() string
// ExactString returns an exact, printable form of the value. // ExactString returns an exact, quoted (human-readable) form of the value.
// If the Value is of Kind String, use StringVal to obtain the unquoted string.
ExactString() string ExactString() string
// Prevent external implementations. // Prevent external implementations.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment