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

Nit: better documentation of experimental status on x/ packages? #918

Closed
bufdev opened this issue Apr 11, 2017 · 0 comments
Closed

Nit: better documentation of experimental status on x/ packages? #918

bufdev opened this issue Apr 11, 2017 · 0 comments

Comments

@bufdev
Copy link
Contributor

bufdev commented Apr 11, 2017

This can be closed if we decide against it, but in the spirit of tracking issues here, I wanted to get this up re #863

Our existing x/ packages do not have much documentation regarding their experimental status, structure, and how they should be used. On encoding/x and transport/x, we do have some documentation on the experimental status, but not much more. transport/x/cherami and x/yarpcmeta have no documentation, encoding/x/protobuf has a basic godoc string, and transport/x/grpc has a little more than a basic godoc string, while x/config has more documenation, and transport/x/redis has the most documentation, and a message about the experimental status at the bottom of the godoc. What should we do?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant