Skip to content

Add samples for data catalog lookup_entry. #7832

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
Closed
wants to merge 4 commits into from
Closed

Add samples for data catalog lookup_entry. #7832

wants to merge 4 commits into from

Conversation

tswast
Copy link
Contributor

@tswast tswast commented May 1, 2019

These samples use the sample generator to call LookupEntry linked to a BigQuery resource.

Depends on internal CL 246050183 to add the GAPIC config for these samples.

@tswast
Add samples for data catalog lookup_entry.
66d9956 
These samples use the sample generator to call LookupEntry linked to a BigQuery resource.

Depends on internal CL 246050183 to add the GAPIC config for these samples.
@tswast tswast added type: docs Improvement to the documentation for an API. api: datacatalog Issues related to the Data Catalog API. labels May 1, 2019
@tswast tswast requested a review from crwilcox as a code owner May 1, 2019 00:00
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label May 1, 2019
tseaver
tseaver reviewed May 1, 2019
View reviewed changes
Copy link
Contributor

@tseaver tseaver left a comment

Choose a reason for hiding this comment

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

ISTM that sample code should not be in the main source tree: our normal convention is to place them in datacatalog/docs/samples.py (or perhaps multiple files there).

@tswast
Copy link
Contributor Author

tswast commented May 1, 2019

GitHub doesn't make it easy to see, but the path is samples/google/cloud/datacatalog_v1beta1/gapic/lookup_entry/datacatalog_lookup_entry_by_sql.py. I've complained about the ridiculously long path names to the generator team, though I haven't filed a bug on it yet.

@tseaver
Copy link
Contributor

tseaver commented May 1, 2019

@tswast I'm not talking about the source from which the sample is generated, but where we put it in this repo: samples for docs should be in the datacatalog/docs subdirectory, not in google/cloud/datacatalog_v1beta1/gapic/: they aren't part of the library, but rather its docs.

@tswast
Copy link
Contributor Author

tswast commented May 1, 2019

Right, I'm saying it's not in google/, it's in samples/. That's just where the generator sticks it. I could work around that by adding move rules to synth.py, but if we do that, we should notify the generator team about why samples/ doesn't work for us. (IMO, samples/ seems appropriate)

CC @beccasaurus

@tseaver
Copy link
Contributor

tseaver commented May 2, 2019

@tswast I noticed just now that BigQuery has a samples subdirectory containing similarly-generated (I think?) samples / snippets. Could we do that for datacatalog, rather than leaving them inside google/cloud?

@tswast tswast added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label May 2, 2019
@yoshi-automation yoshi-automation added the 🚨 This issue needs some love. label May 8, 2019
@tswast
Copy link
Contributor Author

tswast commented Jul 1, 2019

Obsolete by GoogleCloudPlatform/python-docs-samples#2148.

@tswast tswast closed this Jul 1, 2019
@tswast tswast deleted the datacatalog-samples branch July 1, 2019 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@crwilcox crwilcox Awaiting requested review from crwilcox

1 more reviewer

@tseaver tseaver tseaver left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
api: datacatalog Issues related to the Data Catalog API. cla: yes This human has signed the Contributor License Agreement. do not merge Indicates a pull request not ready for merge, due to either quality or timing. 🚨 This issue needs some love. type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@tswast @tseaver @googlebot @yoshi-automation