Skip to content

x/tools/cmd/godoc: package listing readability #5270

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.

Sign up for GitHub

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

Jump to bottom
Closed
anacrolix opened this issue Apr 11, 2013 · 14 comments
Closed

x/tools/cmd/godoc: package listing readability #5270

anacrolix opened this issue Apr 11, 2013 · 14 comments
Labels
FrozenDueToAge
Milestone
Unplanned

Comments

@anacrolix
Copy link
Contributor 

The package listing at http://tip.golang.org/pkg/ is significantly more readable and
navigable than that at http://golang.org/pkg/, but appears this way only due to
misconfiguration. I think the godoc package listings should always look like the former,
misconfiguration or not.
@cznic
Copy link
Contributor

cznic commented Apr 11, 2013

Comment 1:

What specifically is misconfigured and how it should be properly configured instead?

@robpike
Copy link
Contributor

robpike commented Apr 11, 2013

Comment 2:

Are you referring to tip saying
archive/tar
instead of
archive
   tar
?

Status changed to WaitingForReply.

@anacrolix
Copy link
Contributor Author

Comment 3:

Yes.

@mewmew
Copy link
Contributor

mewmew commented May 2, 2013

Comment 4:

Personally I prefer the package listing of http://golang.org/pkg/ over
http://tip.golang.org/pkg/, i.e. using indentation rather than the full package path.
It's easier to visually scan the screen looking for package categories when indentation
is used.
This will always be based on personal preferences, so providing an option for it would
be a good solution.
http://godoc.org/-/go currently lists them the same was as tip does.

@anacrolix
Copy link
Contributor Author

Comment 5:

The style at godoc.org/-/go is far more readable. Try looking at your pkg listing in
godoc when you have mountains of large third-party modules from github, launchpad, etc.
installed at the same time.

@rsc
Copy link
Contributor

rsc commented Jul 30, 2013

Comment 6:

Labels changed: added priority-later, go1.2maybe, removed priority-triage.

@rsc
Copy link
Contributor

rsc commented Jul 30, 2013

Comment 7:

Labels changed: added feature.

@robpike
Copy link
Contributor

robpike commented Aug 29, 2013

Comment 8:

Not for 1.2.

Labels changed: removed go1.2maybe.

@adg
Copy link
Contributor

adg commented Aug 29, 2013

Comment 9:

Now that godoc is decoupled from the core, it doesn't matter so much whether this is
part of 1.2 or not.

@rsc
Copy link
Contributor

rsc commented Nov 27, 2013

Comment 10:

Labels changed: added go1.3maybe.

@rsc
Copy link
Contributor

rsc commented Nov 27, 2013

Comment 11:

Labels changed: removed feature.

@rsc
Copy link
Contributor

rsc commented Dec 4, 2013

Comment 12:

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

@rsc
Copy link
Contributor

rsc commented Dec 4, 2013

Comment 13:

Labels changed: added repo-tools.

@rsc rsc added this to the Unplanned milestone Apr 10, 2015
@rsc rsc changed the title cmd/godoc: package listing readability x/tools/cmd/godoc: package listing readability Apr 14, 2015
@rsc rsc removed the repo-tools label Apr 14, 2015
@agnivade
Copy link
Contributor

@adg - Is this waiting on something ? https://golang.org/pkg/ and https://tip.golang.org/pkg/ look the same now. i.e. - both have indentation.

@adg adg closed this as completed Jan 23, 2018
@golang golang locked and limited conversation to collaborators Jan 23, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge
Projects
None yet
Milestone
Unplanned
Development

No branches or pull requests
8 participants
@rsc @cznic @anacrolix @mewmew @agnivade @robpike @adg @gopherbot