Skip to content
This repository was archived by the owner on May 7, 2026. It is now read-only.

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

Merged
ashleyxuu merged 15 commits into
mainfrom
306030630-create-code-samples
Oct 21, 2023
Merged

test: add sample code for use BigFrames developer guide#118
ashleyxuu merged 15 commits into
mainfrom
306030630-create-code-samples

Conversation

@ashleyxuu
Copy link
Copy Markdown
Contributor

@ashleyxuu ashleyxuu commented Oct 17, 2023

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 a review from a team as a code owner October 17, 2023 23:27
@ashleyxuu ashleyxuu requested review from a team, Genesis929 and vchudnov-g October 17, 2023 23:27
@snippet-bot
Copy link
Copy Markdown

snippet-bot Bot commented Oct 17, 2023 •
edited
Loading

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
tswast
tswast suggested changes Oct 18, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

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

tswast
tswast reviewed Oct 18, 2023
View reviewed changes
Comment thread samples/snippets/sample.py Outdated
@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 October 20, 2023 16:31
tswast
tswast reviewed Oct 20, 2023
View reviewed changes
Comment thread samples/snippets/pandas_methods_test.py Outdated
@ashleyxuu @tswast
Update samples/snippets/pandas_methods_test.py
a6d79e7 
Co-authored-by: Tim Swast <swast@google.com>
@ashleyxuu
Merge branch 'main' into 306030630-create-code-samples
a38d021
@ashleyxuu
Merge branch 'main' into 306030630-create-code-samples
8b46e8a
@ashleyxuu
docs: add runnable code samples for reading methods (#125)
42ec25d 
* 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 subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@vchudnov-g vchudnov-g Awaiting requested review from vchudnov-g vchudnov-g is a code owner automatically assigned from googleapis/python-samples-reviewers

@Genesis929 Genesis929 Awaiting requested review from Genesis929

1 more reviewer

@tswast tswast tswast approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ashleyxuu @tswast