Skip to content

test: add sample code for use BigFrames developer guide #118

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

Merged
merged 15 commits into from
Oct 21, 2023

Conversation

ashleyxuu
Copy link
Contributor

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)

Fixes #<issue_number_goes_here> 🦕

@ashleyxuu ashleyxuu requested review from a team as code owners October 17, 2023 23:27
@snippet-bot
Copy link

snippet-bot bot commented Oct 17, 2023

Here is the summary of changes.

You are about to add 4 region tags.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

@product-auto-label product-auto-label bot added size: m Pull request size is medium. api: bigquery Issues related to the googleapis/python-bigquery-dataframes API. samples Issues that are directly related to samples. labels Oct 17, 2023
@ashleyxuu ashleyxuu requested a review from tswast October 17, 2023 23:28
Copy link
Collaborator

@tswast tswast left a comment

Choose a reason for hiding this comment

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

Since we want these to appear on https://cloud.google.com/bigquery/docs/samples these code samples need to be "standalone".

According to go/code-snippets-101 and https://cloud.google.com/bigquery/docs/samples

"A standalone code snippet demonstrates just one logical action and does not need to be shown with any other code or context to be complete."

"Copy-paste-runnable. A developer should be able to copy and paste the code into their own environment and run it with as few modifications as possible."

To encourace these samples to be standalone, it's a best practice to have 1 code sample per file.

@ashleyxuu ashleyxuu requested a review from tswast October 19, 2023 03:16
@ashleyxuu ashleyxuu added the snippet-bot:force-run Force snippet-bot runs its logic label Oct 19, 2023
@snippet-bot snippet-bot bot removed the snippet-bot:force-run Force snippet-bot runs its logic label Oct 19, 2023
@ashleyxuu ashleyxuu force-pushed the 306030630-create-code-samples branch from e92a8dd to 48a08dc Compare October 20, 2023 04:10
@ashleyxuu ashleyxuu requested a review from a team as a code owner October 20, 2023 16:31
* docs: add runnable and testable I/O code samples

* docs: add runnable and testable reading methods code snippets

* fix: assign a df and show the first 2 rows

* address comments
@product-auto-label product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Oct 21, 2023
@product-auto-label product-auto-label bot added size: m Pull request size is medium. and removed size: l Pull request size is large. labels Oct 21, 2023
@ashleyxuu ashleyxuu merged commit 02984a4 into main Oct 21, 2023
@ashleyxuu ashleyxuu deleted the 306030630-create-code-samples branch October 21, 2023 17:33
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-dataframes API. samples Issues that are directly related to samples. size: m Pull request size is medium.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants