chore: add clarifying comment for the new snippet format (GoogleCloudPlatform#1422)

Author: saranshdhingra

asset/src/batch_get_assets_history.php

@@ -37,5 +37,6 @@ function batch_get_assets_history(string $projectId, array $assetNames)
 }
 # [END asset_quickstart_batch_get_assets_history]
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

asset/src/export_assets.php

@@ -50,5 +50,6 @@ function export_assets(string $projectId, string $dumpFilePath)
 }
 # [END asset_quickstart_export_assets]
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

asset/src/search_all_iam_policies.php

@@ -49,5 +49,6 @@ function search_all_iam_policies(
 }
 // [END asset_quickstart_search_all_iam_policies]
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

asset/src/search_all_resources.php

@@ -55,5 +55,6 @@ function search_all_resources(
 }
 // [END asset_quickstart_search_all_resources]
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

auth/src/auth_api_explicit.php

@@ -49,5 +49,6 @@ function auth_api_explicit($projectId, $serviceAccountPath)
 }
 # [END auth_api_explicit]
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

auth/src/auth_api_implicit.php

@@ -48,5 +48,6 @@ function auth_api_implicit($projectId)
 }
 # [END auth_api_implicit]
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

auth/src/auth_cloud_explicit.php

@@ -49,5 +49,6 @@ function auth_cloud_explicit($projectId, $serviceAccountPath)
 }
 # [END auth_cloud_explicit]
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

auth/src/auth_cloud_implicit.php

@@ -48,5 +48,6 @@ function auth_cloud_implicit($projectId)
 }
 # [END auth_cloud_implicit]
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

auth/src/auth_http_explicit.php

@@ -66,5 +66,6 @@ function auth_http_explicit($projectId, $serviceAccountPath)
 }
 # [END auth_http_explicit]
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

auth/src/auth_http_implicit.php

@@ -62,5 +62,6 @@ function auth_http_implicit($projectId)
 }
 # [END auth_http_implicit]
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_batch_writes.php

@@ -63,5 +63,6 @@ function data_batch_writes(string $projectId): void
     printf('Batch write successfully completed.' . PHP_EOL);
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_delete_collection.php

@@ -53,5 +53,6 @@ function data_delete_collection(string $projectId, string $collectionName, int $
 # [END firestore_data_delete_collection]
 # [END fs_delete_collection]
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_delete_doc.php

@@ -44,5 +44,6 @@ function data_delete_doc(string $projectId): void
     printf('Deleted the DC document in the cities collection.' . PHP_EOL);
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_delete_field.php

@@ -48,5 +48,6 @@ function data_delete_field(string $projectId): void
     printf('Deleted the capital field from the BJ document in the cities collection.' . PHP_EOL);
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_get_all_documents.php

@@ -53,5 +53,6 @@ function data_get_all_documents(string $projectId): void
     # [END fs_get_all_docs]
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_get_as_map.php

@@ -51,5 +51,6 @@ function data_get_as_map(string $projectId): void
     # [END fs_get_document]
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_get_dataset.php

@@ -79,5 +79,6 @@ function data_get_dataset(string $projectId): void
     # [END fs_retrieve_create_examples]
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_get_sub_collections.php

@@ -47,5 +47,6 @@ function data_get_sub_collections(string $projectId): void
     # [END fs_get_collections]
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_query.php

@@ -54,5 +54,6 @@ function data_query(string $projectId): void
     # [END fs_get_multiple_docs]
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_reference_collection.php

@@ -44,5 +44,6 @@ function data_reference_collection(string $projectId): void
     printf('Retrieved collection: %s' . PHP_EOL, $collection->name());
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_reference_document.php

@@ -44,5 +44,6 @@ function data_reference_document(string $projectId): void
     printf('Retrieved document: %s' . PHP_EOL, $document->name());
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_reference_document_path.php

@@ -44,5 +44,6 @@ function data_reference_document_path(string $projectId): void
     printf('Retrieved document from path: %s' . PHP_EOL, $document->name());
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_reference_subcollection.php

@@ -48,5 +48,6 @@ function data_reference_subcollection(string $projectId): void
     printf('Retrieved document from subcollection: %s' . PHP_EOL, $document->name());
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_set_array_operations.php

@@ -55,5 +55,6 @@ function data_set_array_operations(string $projectId): void
     printf('Updated the regions field of the DC document in the cities collection.' . PHP_EOL);
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_set_doc_upsert.php

@@ -47,5 +47,6 @@ function data_set_doc_upsert(string $projectId): void
     printf('Set document data by merging it into the existing BJ document in the cities collection.' . PHP_EOL);
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_set_field.php

@@ -47,5 +47,6 @@ function data_set_field(string $projectId): void
     printf('Updated the capital field of the DC document in the cities collection.' . PHP_EOL);
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_set_from_map.php

@@ -49,5 +49,6 @@ function data_set_from_map(string $projectId): void
     printf('Set data for the LA document in the cities collection.' . PHP_EOL);
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_set_from_map_nested.php

@@ -58,5 +58,6 @@ function data_set_from_map_nested(string $projectId): void
     # [END fs_add_doc_data_types]
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_set_id_random_collection.php

@@ -48,5 +48,6 @@ function data_set_id_random_collection(string $projectId): void
     # [END fs_add_doc_data_with_auto_id]
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_set_id_random_document_ref.php

@@ -49,5 +49,6 @@ function data_set_id_random_document_ref(string $projectId): void
     # [END fs_add_doc_data_after_auto_id]
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_set_id_specified.php

@@ -48,5 +48,6 @@ function data_set_id_specified(string $projectId): void
     printf('Added document with ID: new-city-id' . PHP_EOL);
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_set_nested_fields.php

@@ -57,5 +57,6 @@ function data_set_nested_fields(string $projectId): void
     printf('Updated the age and favorite color fields of the frank document in the users collection.' . PHP_EOL);
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_set_numeric_increment.php

@@ -50,5 +50,6 @@ function data_set_numeric_increment(string $projectId): void
     printf('Updated the population of the DC document in the cities collection.' . PHP_EOL);
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/data_set_server_timestamp.php

@@ -52,5 +52,6 @@ function data_set_server_timestamp(string $projectId): void
     printf('Updated the timestamp field of the some-id document in the objects collection.' . PHP_EOL);
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_collection_group_dataset.php

@@ -85,5 +85,6 @@ function query_collection_group_dataset(string $projectId): void
     # [END fs_collection_group_query_data_setup]
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_collection_group_filter_eq.php

@@ -47,5 +47,6 @@ function query_collection_group_filter_eq(string $projectId): void
     # [END fs_collection_group_query]
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_cursor_end_at_field_value_single.php

@@ -50,5 +50,6 @@ function query_cursor_end_at_field_value_single(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_cursor_pagination.php

@@ -59,5 +59,6 @@ function query_cursor_pagination(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_cursor_start_at_document.php

@@ -53,5 +53,6 @@ function query_cursor_start_at_document(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_cursor_start_at_field_value_multi.php

@@ -63,5 +63,6 @@ function query_cursor_start_at_field_value_multi(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_cursor_start_at_field_value_single.php

@@ -50,5 +50,6 @@ function query_cursor_start_at_field_value_single(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_filter_array_contains.php

@@ -47,5 +47,6 @@ function query_filter_array_contains(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_filter_array_contains_any.php

@@ -47,5 +47,6 @@ function query_filter_array_contains_any(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_filter_compound_multi_eq.php

@@ -49,5 +49,6 @@ function query_filter_compound_multi_eq(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_filter_compound_multi_eq_lt.php

@@ -50,5 +50,6 @@ function query_filter_compound_multi_eq_lt(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_filter_dataset.php

@@ -84,5 +84,6 @@ function query_filter_dataset(string $projectId): void
     # [END fs_query_create_examples]
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_filter_eq_boolean.php

@@ -48,5 +48,6 @@ function query_filter_eq_boolean(string $projectId): void
     # [END fs_create_query_capital]
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_filter_eq_string.php

@@ -48,5 +48,6 @@ function query_filter_eq_string(string $projectId): void
     # [END fs_create_query_state]
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_filter_in.php

@@ -47,5 +47,6 @@ function query_filter_in(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_filter_in_with_array.php

@@ -47,5 +47,6 @@ function query_filter_in_with_array(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_filter_not_eq.php

@@ -45,5 +45,6 @@ function query_filter_not_eq(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_filter_not_in.php

@@ -49,5 +49,6 @@ function query_filter_not_in(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_filter_range_invalid.php

@@ -49,5 +49,6 @@ function query_filter_range_invalid(string $projectId): void
     $invalidRangeQuery->documents();
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_filter_range_valid.php

@@ -49,5 +49,6 @@ function query_filter_range_valid(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_filter_single_examples.php

@@ -55,5 +55,6 @@ function query_filter_single_examples(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_order_desc_limit.php

@@ -48,5 +48,6 @@ function query_order_desc_limit(string $projectId): void
     }
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

firestore/src/query_order_field_invalid.php

@@ -49,5 +49,6 @@ function query_order_field_invalid(string $projectId): void
     $invalidRangeQuery->documents();
 }
 
+// The following 2 lines are only needed to run the samples
 require_once __DIR__ . '/../../testing/sample_helpers.php';
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);