ReadMe file as a snippet of code that is incomplete

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 "..."

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...

@ludoch

@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

@aozarov I was wondering whether we should use the Storage interface or the functional Blob and Bucket ones in the examples (in the readme, package-info and StorageExample).
I think using Blob and Bucket makes 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

Merge pull request googleapis#7 from pongad/pkgrename

chore(deps): update dependency com.google.cloud:google-cloud-core to …

chore(main): release 0.1.1-SNAPSHOT (#7)

chore(main): release 0.1.0 (#7)

deps: update dependency io.grpc:grpc-bom to v1.25.0 (#7)

build: set easymock version to 3.6 which is compatible with java 7 (#7)

deps: update dependency io.grpc:grpc-bom to v1.25.0 (googleapis#7)

chore(deps): update dependency org.apache.maven.plugins:maven-failsaf…

Re-generated to pick up changes in the API or client library generato…

Navigation Menu

Repository navigation

ReadMe file as a snippet of code that is incomplete #7

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

ReadMe file as a snippet of code that is incomplete #7

Description

Activity

aozarov commented on Feb 13, 2015

aozarov commented on Oct 1, 2015

mziccard commented on Oct 2, 2015

aozarov commented on Oct 2, 2015

aozarov commented on Oct 10, 2015

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions