fix(bigquery): Standardized punctuation and style in all documents

hivanalejandro · hivanalejandro · commit 5c048840c9cc · 2025-03-05T19:37:04.000Z
diff --git a/bigquery/cloud-client/grantAccessToDataset.js b/bigquery/cloud-client/grantAccessToDataset.js
@@ -15,18 +15,18 @@
 'use strict';
 
 /**
- * Grants access to a BigQuery dataset for a specified entity
+ * Grants access to a BigQuery dataset for a specified entity.
  *
- * @param {string} datasetId ID of the dataset to grant access to
- * @param {string} entityId ID of the entity to grant access to
- * @param {string} role Role to grant
- * @returns {Promise<Array>} Array of access entries
+ * @param {string} datasetId ID of the dataset to grant access to.
+ * @param {string} entityId ID of the entity to grant access to.
+ * @param {string} role Role to grant.
+ * @returns {Promise<Array>} Array of access entries.
  */
 async function grantAccessToDataset(datasetId, entityId, role) {
   // [START bigquery_grant_access_to_dataset]
   const {BigQuery} = require('@google-cloud/bigquery');
 
-  // Define enum for HTTP codes
+  // Define enum for HTTP codes.
   const HTTP_STATUS = {
     PRECONDITION_FAILED: 412,
   };
@@ -79,7 +79,7 @@ async function grantAccessToDataset(datasetId, entityId, role) {
     // Update will only succeed if the dataset
     // has not been modified externally since retrieval.
     //
-    // See the BigQuery client library documentation for more details on metadata updates
+    // See the BigQuery client library documentation for more details on metadata updates:
     // https://cloud.google.com/nodejs/docs/reference/bigquery/latest
 
     // Update just the 'access entries' property of the dataset.
@@ -89,8 +89,7 @@ async function grantAccessToDataset(datasetId, entityId, role) {
 
     // Show a success message.
     console.log(
-      `Role '${role}' granted for entity '${entityId}'` +
-        ` in dataset '${datasetId}'.`
+      `Role '${role}' granted for entity '${entityId}' in dataset '${datasetId}'.`
     );
 
     return updatedDataset.access;
diff --git a/bigquery/cloud-client/grantAccessToTableOrView.js b/bigquery/cloud-client/grantAccessToTableOrView.js
@@ -15,14 +15,14 @@
 'use strict';
 
 /**
- * Grants access to a BigQuery table or view for a specified principal
+ * Grants access to a BigQuery table or view for a specified principal.
  *
- * @param {string} projectId Google Cloud Platform project ID
- * @param {string} datasetId Dataset where the table or view is
- * @param {string} resourceName Table or view name to get the access policy
- * @param {string} principalId The principal requesting access to the table or view
- * @param {string} role Role to assign to the member
- * @returns {Promise<object[]>} The updated policy bindings
+ * @param {string} projectId Google Cloud Platform project ID.
+ * @param {string} datasetId Dataset where the table or view is.
+ * @param {string} resourceName Table or view name to get the access policy.
+ * @param {string} principalId The principal requesting access to the table or view.
+ * @param {string} role Role to assign to the member.
+ * @returns {Promise<object[]>} The updated policy bindings.
  */
 async function grantAccessToTableOrView(
   projectId,
@@ -34,7 +34,7 @@ async function grantAccessToTableOrView(
   // [START bigquery_grant_access_to_table_or_view]
   const {BigQuery} = require('@google-cloud/bigquery');
 
-  // TODO(developer): Update and un-comment below lines
+  // TODO(developer): Update and un-comment below lines.
 
   // Google Cloud Platform project.
   // projectId = "my_project_id"
diff --git a/bigquery/cloud-client/revokeDatasetAccess.js b/bigquery/cloud-client/revokeDatasetAccess.js
@@ -14,23 +14,22 @@
 
 'use strict';
 
-// Define enum for HTTP codes
+// Define enum for HTTP codes.
 const HTTP_STATUS = {
   PRECONDITION_FAILED: 412,
 };
 
 /**
- * Revokes access to a dataset for a specified entity
+ * Revokes access to a dataset for a specified entity.
  *
- * @param {string} datasetId ID of the dataset to revoke access to
- * @param {string} entityId  ID of the user or group from whom you are revoking access
+ * @param {string} datasetId ID of the dataset to revoke access to.
+ * @param {string} entityId  ID of the user or group from whom you are revoking access.
  *                            Alternatively, the JSON REST API representation of the entity,
- *                            such as a view's table reference
- * @returns {Promise<Array>} A promise that resolves to the updated access entries
+ *                            such as a view's table reference.
+ * @returns {Promise<Array>} A promise that resolves to the updated access entries.
  */
 async function revokeDatasetAccess(datasetId, entityId) {
   // [START bigquery_revoke_dataset_access]
-  // Imports the Google Cloud client library.
   const {BigQuery} = require('@google-cloud/bigquery');
 
   // TODO (developer): Update and un-comment below lines.
@@ -49,15 +48,15 @@ async function revokeDatasetAccess(datasetId, entityId) {
   // Get a reference to the dataset.
   const [dataset] = await bigquery.dataset(datasetId).get();
 
-  // To revoke access to a dataset, remove elements from the access list
+  // To revoke access to a dataset, remove elements from the access list.
   //
-  // See the BigQuery client library documentation for more details on access entries
+  // See the BigQuery client library documentation for more details on access entries:
   // https://cloud.google.com/nodejs/docs/reference/secret-manager/4.1.4
 
   // Filter access entries to exclude entries matching the specified entity_id
   // and assign a new list back to the access list.
   dataset.metadata.access = dataset.metadata.access.filter(entry => {
-    // Return false (remove entry) if any of these fields match entityId
+    // Return false (remove entry) if any of these fields match entityId.
     return !(
       entry.entity_id === entityId ||
       entry.userByEmail === entityId ||
diff --git a/bigquery/cloud-client/revokeTableOrViewAccess.js b/bigquery/cloud-client/revokeTableOrViewAccess.js
@@ -15,13 +15,13 @@
 'use strict';
 
 /**
- * Revokes access to a BigQuery table or view
- * @param {string} projectId The ID of the Google Cloud project
- * @param {string} datasetId The ID of the dataset containing the table/view
- * @param {string} resourceName The ID of the table or view
- * @param {string} [roleToRemove=null] Optional. Specific role to revoke
- * @param {string} [principalToRemove=null] Optional. Specific principal to revoke access from
- * @returns {Promise<Object>} The updated IAM policy
+ * Revokes access to a BigQuery table or view.
+ * @param {string} projectId The ID of the Google Cloud project.
+ * @param {string} datasetId The ID of the dataset containing the table/view.
+ * @param {string} resourceName The ID of the table or view.
+ * @param {string} [roleToRemove=null] Optional. Specific role to revoke.
+ * @param {string} [principalToRemove=null] Optional. Specific principal to revoke access from.
+ * @returns {Promise<Object>} The updated IAM policy.
  */
 async function revokeAccessToTableOrView(
   projectId,
@@ -31,10 +31,10 @@ async function revokeAccessToTableOrView(
   principalToRemove = null
 ) {
   // [START bigquery_revoke_access_to_table_or_view]
-  // Imports the Google Cloud client library.
   const {BigQuery} = require('@google-cloud/bigquery');
 
-  // TODO (developer): Update and un-comment below lines
+  // TODO (developer): Update and un-comment below lines.
+
   // Google Cloud Platform project.
   // projectId = "my_project_id"
 
diff --git a/bigquery/cloud-client/viewDatasetAccessPolicy.js b/bigquery/cloud-client/viewDatasetAccessPolicy.js
@@ -15,19 +15,19 @@
 'use strict';
 
 /**
- * View access policies for a BigQuery dataset
- * @param {string} datasetId Dataset ID to view access policies for
- * @returns {Array} List of access entries
+ * View access policies for a BigQuery dataset.
+ * @param {string} datasetId Dataset ID to view access policies for.
+ * @returns {Array} List of access entries.
  */
 function viewDatasetAccessPolicy(datasetId) {
   // [START bigquery_view_dataset_access_policy]
-  // Import the Google Cloud client library.
   const {BigQuery} = require('@google-cloud/bigquery');
 
   // Instantiate a client.
   const bigquery = new BigQuery();
 
   // TODO (developer): Update and un-comment below lines.
+
   // Dataset from which to get the access policy
   // datasetId = "my_dataset_id";
 
@@ -38,7 +38,7 @@ function viewDatasetAccessPolicy(datasetId) {
     const accessEntries = metadata.access || [];
 
     // Show the list of AccessEntry objects.
-    // More details about the AccessEntry object in the BigQuery documentation
+    // More details about the AccessEntry object in the BigQuery documentation:
     // https://cloud.google.com/nodejs/docs/reference/bigquery/latest
     console.log(
       `${accessEntries.length} Access entries in dataset '${datasetId}':`
diff --git a/bigquery/cloud-client/viewTableOrViewAccessPolicy.js b/bigquery/cloud-client/viewTableOrViewAccessPolicy.js
@@ -15,23 +15,25 @@
 'use strict';
 
 /**
- * View access policy for a BigQuery table or view
+ * View access policy for a BigQuery table or view.
  *
- * @param {string} projectId Google Cloud Platform project
- * @param {string} datasetId Dataset where the table or view is
- * @param {string} resourceName Table or view name to get the access policy
- * @returns {Promise<object>} The IAM policy object
+ * @param {string} projectId Google Cloud Platform project.
+ * @param {string} datasetId Dataset where the table or view is.
+ * @param {string} resourceName Table or view name to get the access policy.
+ * @returns {Promise<object>} The IAM policy object.
  */
 async function viewTableOrViewAccessPolicy(projectId, datasetId, resourceName) {
   // [START bigquery_view_table_or_view_access_policy]
-  // Imports the Google Cloud client library
   const {BigQuery} = require('@google-cloud/bigquery');
 
-  // TODO(developer): Update and un-comment below lines
+  // TODO(developer): Update and un-comment below lines.
+
   // Google Cloud Platform project.
   // projectId = "my_project_id";
+
   // Dataset where the table or view is.
   // datasetId = "my_dataset_id";
+
   // Table or view name to get the access policy.
   // resourceName = "my_table_name_id";
 
