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

Clean up the "hello world" code sample #328

Merged
merged 3 commits into from
Oct 21, 2018
Merged

Clean up the "hello world" code sample #328

merged 3 commits into from
Oct 21, 2018

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