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

doc: extract examples from tests #11248

Closed
ucirello opened this issue Jun 17, 2015 · 8 comments
Closed

doc: extract examples from tests #11248

ucirello opened this issue Jun 17, 2015 · 8 comments

Comments

@ucirello
Copy link
Contributor

I suggest digging tests and extract meaningful examples from them.

If approved, I can produce a set of CLs for that.

@ucirello
Copy link
Contributor Author

Related issues
#5757
#11241

@ianlancetaylor
Copy link
Contributor

Are you suggesting some sort of automated process? I don't think that is a good idea.

If you are suggesting that people manually look at tests and use them to construct examples, then, sure. I don't think we need a general issue open for that, though.

@ucirello
Copy link
Contributor Author

@ianlancetaylor definitely manually. I haven't even considered the idea of doing it automatically.

I open this issue here, so later I would peg case by case CL and Issues into this one. But if this is done differently, I do not mind closing this and going along with whatever is the right thing.

@ianlancetaylor
Copy link
Contributor

I think this topic is too general for a catch all issue to be useful.

@ucirello
Copy link
Contributor Author

@ianlancetaylor so what am I supposed to do?

@ianlancetaylor
Copy link
Contributor

I don't understand what you are asking.

I am completely in favor of looking at tests and turning them into examples. I think you should do that.

I just don't think that this issue is helpful.

@ucirello
Copy link
Contributor Author

@ianlancetaylor I apologize for not being clear. I would like to know whether opening CL with the individual changes is enough, or should I open issues for each CL I post.

@ianlancetaylor
Copy link
Contributor

You can just send in a CL. There is no need to open an issue for each CL.

@golang golang locked and limited conversation to collaborators Jun 25, 2016
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