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/godoc: misnamed examples should be handled better #4211

Closed
dsymonds opened this issue Oct 8, 2012 · 7 comments
Closed

cmd/godoc: misnamed examples should be handled better #4211

dsymonds opened this issue Oct 8, 2012 · 7 comments
Labels
FrozenDueToAge Suggested Issues that may be good for new contributors looking for work to do.
Milestone

Comments

@dsymonds
Copy link
Contributor

dsymonds commented Oct 8, 2012

I went to add an example for encoding/base64, and created func ExampleEncodeToString.
That was enough for godoc to pick it up and put it in the table of contents, but the
example was nowhere to be seen on the page. That's understandable because it should have
been called ExampleEncoding_EncodeToString, but the failure mode here wasn't great.

If the example won't be present on the page, don't put it in the table of contents, and
preferably log an error or something.
@robpike
Copy link
Contributor

robpike commented Oct 10, 2012

Comment 1:

Labels changed: added priority-later, removed priority-triage.

@adg
Copy link
Contributor

adg commented Oct 10, 2012

Comment 2:

Labels changed: added go1.1maybe, removed go1.1.

@rsc
Copy link
Contributor

rsc commented Dec 10, 2012

Comment 4:

Labels changed: added size-m.

@rsc
Copy link
Contributor

rsc commented Dec 10, 2012

Comment 5:

Labels changed: added suggested.

@kisielk
Copy link
Contributor

kisielk commented Dec 20, 2012

Comment 6:

I submitted https://golang.org/cl/6970051

@adg
Copy link
Contributor

adg commented Dec 20, 2012

Comment 7:

Status changed to Started.

@adg
Copy link
Contributor

adg commented Jan 2, 2013

Comment 8:

This issue was closed by revision 267a553.

Status changed to Fixed.

@dsymonds dsymonds added fixed Suggested Issues that may be good for new contributors looking for work to do. labels Jan 2, 2013
@rsc rsc added this to the Go1.1 milestone Apr 14, 2015
@rsc rsc removed the go1.1maybe label Apr 14, 2015
@golang golang locked and limited conversation to collaborators Jun 24, 2016
@rsc rsc unassigned adg Jun 22, 2022
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
FrozenDueToAge Suggested Issues that may be good for new contributors looking for work to do.
Projects
None yet
Development

No branches or pull requests

6 participants