Skip to content

docs: clarify %%bigquery` magics and fix broken link #508

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.

Sign up for GitHub

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

Jump to bottom
Merged
plamut merged 1 commit into from
Feb 16, 2021
Merged

docs: clarify %%bigquery` magics and fix broken link #508

plamut merged 1 commit into from
Feb 16, 2021

Conversation

@tswast
Copy link
Contributor

@tswast tswast commented Feb 3, 2021 •
edited
Loading

The link at https://googleapis.dev/python/bigquery/latest/usage/index.html
was broken. Also, I was having trouble remembering what I needed to do to
enable the %%bigquery extension, so I put that prerequisite right at the
top of the docs.

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)
@tswast tswast requested review from a team and stephaniewang526 and removed request for a team February 3, 2021 18:07
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Feb 3, 2021
@product-auto-label product-auto-label bot added the api: bigquery Issues related to the googleapis/python-bigquery API. label Feb 3, 2021
@tswast tswast requested review from shollyman and steffnay February 3, 2021 18:09
@plamut plamut added the type: docs Improvement to the documentation for an API. label Feb 16, 2021
plamut
plamut approved these changes Feb 16, 2021
View reviewed changes
Copy link
Contributor

@plamut plamut left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. The link in the docs now works and explaining how to load the extension can be useful, too.
@plamut plamut merged commit eedf93b into googleapis:master Feb 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: bigquery Issues related to the googleapis/python-bigquery API. cla: yes This human has signed the Contributor License Agreement. type: docs Improvement to the documentation for an API.

3 participants

@tswast @shollyman @plamut