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/godoc: Possible improvements #5637

Closed
ianlancetaylor opened this issue Jun 4, 2013 · 7 comments

Comments

Projects
None yet
8 participants
@ianlancetaylor
Copy link
Contributor

commented Jun 4, 2013

Some improvement we could make to godoc.  Split these up into separate issues if it's
easier.

* Add the ability for godoc-specific comments.  This would not be markup as such, but
would be ways to organize the presented docs.  For example, a way to indicate which
names in a package are important and which are not.  The important names would appear
first.  The unimportant ones would be hidden by default.

* When the text has a capitalized word that is the same as an exported name in the
package, link the text to the docs for that name.

* Provide some way to automatically know which types implement which interfaces, ideally
across packages.
@griesemer

This comment has been minimized.

Copy link
Contributor

commented Sep 16, 2013

Comment 1:

Owner changed to @adg.

@mewmew

This comment has been minimized.

Copy link
Contributor

commented Nov 4, 2013

Comment 2:

> * Provide some way to automatically know which types implement which interfaces,
ideally across packages.
The following package may serve as inspiration.
https://github.com/dominikh/implements
@rsc

This comment has been minimized.

Copy link
Contributor

commented Nov 27, 2013

Comment 3:

Labels changed: added go1.3maybe.

@rsc

This comment has been minimized.

Copy link
Contributor

commented Dec 4, 2013

Comment 4:

Labels changed: added release-none, removed go1.3maybe.

@rsc

This comment has been minimized.

Copy link
Contributor

commented Dec 4, 2013

Comment 5:

Labels changed: added repo-tools.

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

@rsc rsc changed the title cmd/godoc: Possible improvements x/tools/cmd/godoc: Possible improvements Apr 14, 2015

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

@bradfitz

This comment has been minimized.

Copy link
Member

commented Feb 2, 2017

Item 2 seems to be happening in #18342

@mvdan

This comment has been minimized.

Copy link
Member

commented Aug 26, 2017

Item 3 (a restricted version of it) is at #20131, accepted as a proposal.

@adg adg closed this Feb 14, 2018

@golang golang locked and limited conversation to collaborators Feb 14, 2019

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