Skip to content

Add commented variables to make samples more friendly to copy and use #4365

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

Merged
engelke merged 2 commits into from
Jul 24, 2020
Merged

Add commented variables to make samples more friendly to copy and use #4365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3d891a
Add commented variables to make samples more friendly to copy and use
yuyifan-google Jul 23, 2020
5c17349
Merge branch 'master' into master
yuyifan-google Jul 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions asset/cloud-client/quickstart_searchalliampolicies.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ def search_all_iam_policies(scope, query=None, page_size=None):
# [START asset_quickstart_search_all_iam_policies]
from google.cloud import asset_v1

# TODO scope = 'Scope of the search'

@engelke engelke Jul 23, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why are these labeled TODO? This is just a description, right, not a future task. Or am I missing something?

@yuyifan-google yuyifan-google Jul 23, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm following the style in some of our team's existing samples (e.g., createfeed.py)
Is there a particular style I should use for these commented variables?

@engelke engelke Jul 23, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No, if that's been used before, let's keep it.

# TODO query = 'Query statement'
# TODO page_size = Size of each result page

client = asset_v1.AssetServiceClient()
response = client.search_all_iam_policies(
scope, query=query, page_size=page_size)
Expand Down
6 changes: 6 additions & 0 deletions asset/cloud-client/quickstart_searchallresources.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ def search_all_resources(scope,
# [START asset_quickstart_search_all_resources]
from google.cloud import asset_v1

# TODO scope = 'Scope of the search'
# TODO query = 'Query statement'
# TODO asset_types = 'List of asset types to search for'
# TODO page_size = Size of each result page
# TODO order_by = 'Fields to sort the results'

client = asset_v1.AssetServiceClient()
response = client.search_all_resources(
scope,
Expand Down