qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-24 04:30:14 -07:00
Code Releases Activity

go/types: improved documentation for WriteExpr and ExprString

Browse Source 
Fixes #22377.

Change-Id: I0a0e1bde558df964f0961dc4cfc305e72d590e1a
Reviewed-on: https://go-review.googlesource.com/72690
Reviewed-by: Alan Donovan <adonovan@google.com>
This commit is contained in:
griesemer 2017-10-23 10:48:46 -07:00 committed by Robert Griesemer
parent 083338cb97
commit 0316d6618c
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/go/types/exprstring.go
View File

@ -11,14 +11,18 @@ import (
"go/ast" "go/ast"
) )
// ExprString returns the (possibly simplified) string representation for x. // ExprString returns the (possibly shortened) string representation for x.
// Shortened representations are suitable for user interfaces but may not
// necessarily follow Go syntax.
func ExprString(x ast.Expr) string { func ExprString(x ast.Expr) string {
var buf bytes.Buffer var buf bytes.Buffer
WriteExpr(&buf, x) WriteExpr(&buf, x)
return buf.String() return buf.String()
} }
// WriteExpr writes the (possibly simplified) string representation for x to buf. // WriteExpr writes the (possibly shortened) string representation for x to buf.
// Shortened representations are suitable for user interfaces but may not
// necessarily follow Go syntax.
func WriteExpr(buf *bytes.Buffer, x ast.Expr) { func WriteExpr(buf *bytes.Buffer, x ast.Expr) {
// The AST preserves source-level parentheses so there is // The AST preserves source-level parentheses so there is
// no need to introduce them here to correct for different // no need to introduce them here to correct for different
@ -44,12 +48,12 @@ func WriteExpr(buf *bytes.Buffer, x ast.Expr) {
case *ast.FuncLit: case *ast.FuncLit:
buf.WriteByte('(') buf.WriteByte('(')
WriteExpr(buf, x.Type) WriteExpr(buf, x.Type)
buf.WriteString(" literal)") // simplified buf.WriteString(" literal)") // shortened
case *ast.CompositeLit: case *ast.CompositeLit:
buf.WriteByte('(') buf.WriteByte('(')
WriteExpr(buf, x.Type) WriteExpr(buf, x.Type)
buf.WriteString(" literal)") // simplified buf.WriteString(" literal)") // shortened
case *ast.ParenExpr: case *ast.ParenExpr:
buf.WriteByte('(') buf.WriteByte('(')