docs: add Samples section to CONTRIBUTING.rst #380
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![gcf-owl-bot[bot]](https://avatars.githubusercontent.com/in/99011?s=60&v=4){kind=small}
Source-Link: googleapis/synthtool@52e4e46 Post-Processor: gcr.io/repo-automation-bots/owlbot-python:latest@sha256:6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605
trusted-contributions-gcf
bot
added
kokoro:force-run
product-auto-label
bot
added
the
api: bigtable
google-cla
bot
added
the
cla: yes
yoshi-kokoro
removed
the
kokoro:force-run
gcf-owl-bot
bot
removed
the
owlbot:run
parthea
added
the
do not merge
crwilcox
reviewed
Jul 20, 2021
CONTRIBUTING.rst
Outdated
| The tests will run against a real Google Cloud Project, so you should | ||
| configure them just like the System Tests. | ||
|
|
||
| - To run sample tests, you can execute:: |
There was a problem hiding this comment.
This seems explicit, but this is a single sort of sample. There are many in bigtable. When I read this it sort of reads like the only samples are samples/snippets.
There was a problem hiding this comment.
cc: @busunkim96 @parthea is this unique to bigtable (having so many other directories in samples)
There was a problem hiding this comment.
python-spannerhas one directory of samples, oddly enough nested undersamples/samples. Logically they could be broken up, rooted at justsamples/, but that would break docs.python-bigqueryhas an odd mix: lots of samples in justsamples/, but the test drivers are insamples/tests/, and the snippets aresamples/snippets/, along with their test drivers.python-pubsubonly has runnable samples insamples/snippets/, including their test drivers.python-storagehas no samples.
The generated libraries have, interestingly, almost as wide a range.
There was a problem hiding this comment.
In BigQuery, the goal is to have samples that just require the google-cloud-bigquery library in samples/snippets, but with other directories like samples/geography and sample/pandas for samples that have extra dependencies.
Just filed googleapis/python-bigquery#790 to actually document this goal.
crwilcox
added
the
kokoro:force-run
yoshi-kokoro
removed
the
kokoro:force-run
parthea
removed
the
do not merge
parthea
approved these changes
Jul 22, 2021
parthea
approved these changes
Jul 22, 2021
parthea
added
the
automerge
parthea
approved these changes
Jul 22, 2021
parthea
approved these changes
Jul 22, 2021
parthea
approved these changes
Jul 22, 2021
parthea
added
kokoro:force-run
yoshi-kokoro
removed
kokoro:run
tseaver
changed the title
tseaver
removed
the
automerge
|
@parthea Please don't automerge -- we need to ensure that the squash merge commit uses |
parthea
added
the
do not merge
…294929221d060634dae4a0795c1cefdbc995b2d605
trusted-contributions-gcf
bot
added
kokoro:force-run
|
Superseded by #396 |
gcf-owl-bot
bot
removed
the
owlbot:run
tseaver
deleted the
owl-bot-update-lock-6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Source-Link: googleapis/synthtool@52e4e46
Post-Processor: gcr.io/repo-automation-bots/owlbot-python:latest@sha256:6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605