-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
Enhancements to examples #5467
Comments
I don't disagree, but some of the reasons for the current directory structure: 1) separating examples with different dependencies and 2) letting users copy-paste the examples (because lots of people try to copy-paste).
This is not actionable. Were there specific things that you saw that needing resolving?
No. We want to add examples as we add features and want to make sure we don't break the examples. Our documentation says to check out the latest tagged release. The one possibility here is to have nightly/continuous snapshot builds that the examples could use. |
There are examples under examples/src/main/java/io/grpc/examples/ and then there are sub- directories for other examples under examples/ (android/, example-alts/ and so on). I don't know if that's by design, and whether that structure can be changed to make it more intuitive or consistent.
You are right - I have seen stuff (text in readme files) that can be corrected but I should list it to make it actionable or open a PR to fix them myself. Will try to do that.
Yes, the doc does say that but people might be interested in the latest examples e.g. stuff added since the latest tagged release. Also I thought there is almost always a delay between when a new feature is added to the grpc library and when the example using that feature is added. But if both are added together then I agree the current mechanism is needed.
That is a great idea and can address the problem as well. |
Each of those have different dependencies (e.g., Android, ALTS).
Where does it say that? If it encourages using master, that should be changed.
We do update the examples at the same time when we deprecate an API or introduce a direct replacement for an existing API. While I agree new examples aren't written often, existing examples are updated immediately when appropriate. |
I meant to say the doc does mention using latest release tag (and not master).
One can imagine developers using examples as the starting point for writing new gRPC applications and then going on to build their apps for production. In that case it is best for that starting point (i.e. examples) to be based on released gRPC code instead of SNAPSHOT. But that's just my (not so strong) opinion. |
I'm sorry. I see now I misread what you said.
In that case we don't want them to use the un-released examples. They would need to wait for a gRPC release to use any recently-added features and if we add something and then delete it within a release they will be trying to use something that "never existed." If users check out |
Please answer these questions before submitting your issue.
What version of gRPC are you using?
Latest
What did you expect to see?
The text was updated successfully, but these errors were encountered: