Skip to content

Clean up the "hello world" code sample#328

Merged
sduskis merged 3 commits intogoogleapis:masterfrom
hegemonic:hello-world-cleanup
Oct 21, 2018
Merged

Clean up the "hello world" code sample#328
sduskis merged 3 commits intogoogleapis:masterfrom
hegemonic:hello-world-cleanup

Conversation

@hegemonic
Copy link
Contributor

@hegemonic hegemonic commented Oct 19, 2018

Changes to code:

  • Add region tags for including code in docs
  • Change require() call for consistency with the API docs; the sample now requires the library as Bigtable and creates an instance of it by calling new Bigtable()
  • Add comments about shortcuts that would cause performance issues in production
  • Fix misspelled variable

Changes to README:

  • Fix branding issues
  • Update auth instructions to use the current best practice; gcloud auth application-default login is no longer recommended
  • Update links to the GCP Console
  • Remove embedded screenshot from the docs, to prevent a broken image if that screenshot goes away
  • Miscellaneous changes for clarity and consistency

Fixes #<issue_number_goes_here> (it's a good idea to open an issue first for discussion)

  • Tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Changes to code:
+ Add region tags for including code in docs
+ Change `require()` call for consistency with the API docs; the sample now requires the library as `Bigtable` and creates an instance of it by calling `new Bigtable()`
+ Add comments about shortcuts that would cause performance issues in production
+ Fix misspelled variable

Changes to `README`:
+ Fix branding issues
+ Update auth instructions to use the current best practice; `gcloud auth application-default login` is no longer recommended
+ Update links to the GCP Console
+ Remove embedded screenshot from the docs, to prevent a broken image if that screenshot goes away
+ Miscellaneous changes for clarity and consistency
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Oct 19, 2018
@ghost ghost assigned sduskis Oct 21, 2018
@sduskis sduskis merged commit 13e3d76 into googleapis:master Oct 21, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants