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

x/tools/cmd/eg: needs package documentation #10257

crawshaw opened this issue Mar 26, 2015 · 2 comments


None yet
5 participants
Copy link

commented Mar 26, 2015

I pointed someone to, which unhelpfully says "For documentation, run the command , or see Help in". The command cannot be run on mobile, so they following the unclickable link (with some effort) to discover a Help that is not helpful:

const Help = "" /* 4235 byte string literal not displayed */

Please consider using the technique adopted by the Go tool for package documentation: it is generated from help output.


This comment has been minimized.

Copy link

commented Mar 26, 2015


This comment has been minimized.

Copy link
Contributor Author

commented Mar 26, 2015

That's really a separate bug though. Package documentation would be a lot nicer out of a string.

@rsc rsc added this to the Unplanned milestone Apr 10, 2015

@rsc rsc changed the title tools/cmd/eg: needs package documentation x/tools/cmd/eg: needs package documentation Apr 14, 2015

@rsc rsc modified the milestones: Unreleased, Unplanned Apr 14, 2015

@rsc rsc removed the repo-tools label Apr 14, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.