Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cmd/doc: omit symbol list for docs about command #10733

Closed
rsc opened this issue May 7, 2015 · 3 comments
Closed

cmd/doc: omit symbol list for docs about command #10733

rsc opened this issue May 7, 2015 · 3 comments
Milestone

Comments

@rsc
Copy link
Contributor

rsc commented May 7, 2015

You can't import cover the first two lines of this output and the block at the end should be omitted. Perhaps if -u were given it would make sense to show them?

g% go doc cover
package main // import "cmd/cover"

Cover is a program for analyzing the coverage profiles generated by 'go test
-coverprofile=cover.out'.

Cover is also used by 'go test -cover' to rewrite the source code with
annotations to track which parts of each function are executed. It operates on
one Go source file at a time, computing approximate basic block information by
studying the source. It is thus more portable than binary-rewriting coverage
tools, but also a little less capable. For instance, it does not probe inside &&
and || expressions, and can be mildly confused by single statements with
multiple function literals.

For usage information, please see:

    go help testflag
    go tool cover -help

func ParseProfiles(fileName string) ([]*Profile, error)
type Block struct { ... }
type Boundary struct { ... }
type File struct { ... }
type FuncExtent struct { ... }
type FuncVisitor struct { ... }
type Profile struct { ... }
type ProfileBlock struct { ... }
g%
@rsc rsc added this to the Go1.5 milestone May 7, 2015
@robpike
Copy link
Contributor

robpike commented May 7, 2015

You can't import it (well, a test could) but it can be helpful to know where the source comes from. That's a question I want the answer to quite often.

I'd rather leave it.

@robpike
Copy link
Contributor

robpike commented May 8, 2015

Will consider the suggestion for -u and the exported symbols, although it makes the specification of what the command does more complicated.

@rsc rsc changed the title cmd/doc: omit package, import, exported symbol list for docs about command cmd/doc: omit symbol list for docs about command Jun 8, 2015
@gopherbot
Copy link

CL https://golang.org/cl/11953 mentions this issue.

@robpike robpike closed this as completed in 91976aa Jul 9, 2015
@golang golang locked and limited conversation to collaborators Jul 11, 2016
@rsc rsc unassigned robpike Jun 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants