Stowage/go
2
0
Fork 0
mirror of https://github.com/golang/go.git synced 2025-12-08 06:10:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

cmd/doc: truncate long lists of arguments

Browse source 
Some field-lists (especially in generated code) can be excessively long.
In the one-line printout, it does not make sense to print all elements
of the list if line-wrapping causes the "one-line" to become multi-line.

// Before:
var LongLine = newLongLine("someArgument1", "someArgument2", "someArgument3", "someArgument4", "someArgument5", "someArgument6", "someArgument7", "someArgument8")

// After:
var LongLine = newLongLine("someArgument1", "someArgument2", "someArgument3", "someArgument4", ...)

Change-Id: I4bbbe2dbd1d7be9f02d63431d213088c3dee332c
Reviewed-on: https://go-review.googlesource.com/36031
Run-TryBot: Joe Tsai <thebrokentoaster@gmail.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Rob Pike <r@golang.org>
This commit is contained in:
Joe Tsai 2017-01-11 16:53:49 -08:00 • committed by Joe Tsai
parent ea5529de15
commit a1ea91219f
3 changed files with 35 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

23
src/cmd/doc/pkg.go
View file

@ -281,11 +281,11 @@ func (pkg *Package) oneLineNodeDepth(node ast.Node, depth int) string {
}
}
param := strings.Join(params, ", ")
param := joinStrings(params)
if len(results) == 0 {
return fmt.Sprintf("func(%s)", param)
}
result := strings.Join(results, ", ")
result := joinStrings(results)
if !needParens {
return fmt.Sprintf("func(%s) %s", param, result)
}
@ -338,7 +338,7 @@ func (pkg *Package) oneLineNodeDepth(node ast.Node, depth int) string {
for _, arg := range n.Args {
args = append(args, pkg.oneLineNodeDepth(arg, depth))
}
return fmt.Sprintf("%s(%s)", fnc, strings.Join(args, ", "))
return fmt.Sprintf("%s(%s)", fnc, joinStrings(args))
case *ast.UnaryExpr:
return fmt.Sprintf("%s%s", n.Op, pkg.oneLineNodeDepth(n.X, depth))
@ -367,7 +367,21 @@ func (pkg *Package) oneLineField(field *ast.Field, depth int) string {
if len(names) == 0 {
return pkg.oneLineNodeDepth(field.Type, depth)
}
return strings.Join(names, ", ") + " " + pkg.oneLineNodeDepth(field.Type, depth)
return joinStrings(names) + " " + pkg.oneLineNodeDepth(field.Type, depth)
}
// joinStrings formats the input as a comma-separated list,
// but truncates the list at some reasonable length if necessary.
func joinStrings(ss []string) string {
var n int
for i, s := range ss {
n += len(s) + len(", ")
if n > punchedCardWidth {
ss = append(ss[:i:i], "...")
break
}
}
return strings.Join(ss, ", ")
}
// packageDoc prints the docs for the package (package doc plus one-liners of the rest).
@ -787,7 +801,6 @@ func (pkg *Package) printMethodDoc(symbol, method string) bool {
}
name := iMethod.Names[0].Name
if match(method, name) {
// pkg.oneLineField(iMethod, 0)
if iMethod.Doc != nil {
for _, comment := range iMethod.Doc.List {
doc.ToText(&pkg.buf, comment.Text, "", indent, indentedWidth)