Repository navigation
ReadMe file as a snippet of code that is incomplete #7
Description
Activity
How about replacing the "..." for dataset with "'dataset-id' and "myKind" in the kind part?
I don't think that putting the code after the imports in a static method is the right thing to do (even though
that can make it a more "compilable code") for the following:- It is not likely that the method would be used as is.
- adding unnecessary lines of code, just a distraction which would require another level of indentation.
- Can't be used as is. Still need to be put in a class appropriately and I think it would be clear to an Java developer that it should also be put in some method when as-is.
In any case, I don't feel strongly about it. Let me know what you think...
- added this to the milestone
on Feb 17, 2015 @ludoch So, I think we do that now for datastore, is that what you were thinking of?
We need one for storage as well. Maybe something similar to the package-info.
Also, once @mziccard thinks we are ready we should probably update the main readme.
@aozarov I was wondering whether we should use the
Storageinterface or the functionalBlobandBucketones in the examples (in the readme, package-info andStorageExample).
I think usingBlobandBucketmakes more sense for a simple usage example.I think using Blob and Bucket makes more sense for a simple usage example.
Agree.
Same snippet is now available in each module package-info as well as its README.md
- added a commit that references this issue
on Mar 29, 2016 - added a commit that references this issue
on Jun 29, 2022 - added a commit that references this issue
on Aug 16, 2022 - added a commit that references this issue
on Sep 15, 2022 - added a commit that references this issue
on Dec 22, 2025 - added a commit that references this issue
on Jan 22, 2026 - added a commit that references this issue
on Mar 11, 2026 - added a commit that references this issue
on Mar 23, 2026
It would be great to get a working snippet in the readme page(without looking at the javadoc first):
1/ a static method after the imports?
2/ some real content for the "..." section (or some comments in the snippet to describe what would be the value for "..."