Apply suggestions from code review

Co-Authored-By: David Supplee <[email protected]>

Author: frankyn

storage/src/activate_hmac_key.php

@@ -27,9 +27,9 @@
 use Google\Cloud\Storage\StorageClient;
 
 /**
- * Activate HMAC key.
+ * Activate an HMAC key.
  *
- * @param string $accessId access ID for an inactive HMAC key.
+ * @param string $accessId Access ID for an inactive HMAC key.
  * @param string $projectId Google Cloud Project ID.
  *
  */

storage/src/create_hmac_key.php

@@ -29,7 +29,7 @@
 /**
  * Create a new HMAC key.
  *
- * @param string $serviceAccountEmail service account email to associate with new HMAC key.
+ * @param string $serviceAccountEmail Service account email to associate with the new HMAC key.
  * @param string $projectId Google Cloud Project ID.
  *
  */

storage/src/deactivate_hmac_key.php

@@ -27,9 +27,9 @@
 use Google\Cloud\Storage\StorageClient;
 
 /**
- * Deactivate HMAC key.
+ * Deactivate an HMAC key.
  *
- * @param string $accessId access ID for an inactive HMAC key.
+ * @param string $accessId Access ID for an inactive HMAC key.
  * @param string $projectId Google Cloud Project ID.
  *
  */

storage/src/delete_hmac_key.php

@@ -27,9 +27,9 @@
 use Google\Cloud\Storage\StorageClient;
 
 /**
- * Delete HMAC key.
+ * Delete an HMAC key.
  *
- * @param string $accessId access ID for an inactive HMAC key.
+ * @param string $accessId Access ID for an HMAC key.
  * @param string $projectId Google Cloud Project ID.
  *
  */

storage/src/get_hmac_key.php

@@ -27,9 +27,9 @@
 use Google\Cloud\Storage\StorageClient;
 
 /**
- * Get HMAC key.
+ * Get an HMAC key.
  *
- * @param string $accessId access ID for HMAC key.
+ * @param string $accessId Access ID for an HMAC key.
  * @param string $projectId Google Cloud Project ID.
  *
  */

storage/src/list_hmac_keys.php

@@ -35,7 +35,7 @@
 function list_hmac_keys($projectId)
 {
     $storage = new StorageClient();
-    // By default hmacKeys will use the projectId used by StorageClient() list HMAC Keys.
+    // By default hmacKeys will use the projectId used by StorageClient() to list HMAC Keys.
     $hmacKeys = $storage->hmacKeys(['projectId' => $projectId]);
 
     foreach ($hmacKeys as $hmacKey) {

storage/storage.php

@@ -434,13 +434,13 @@
 $application->add(new Command('hmac-sa-list'))
     ->setDescription('List Cloud Storage HMAC Keys.')
     ->setHelp(<<<EOF
-The <info>%command.name%</info> command list Cloud Storage HMAC Keys.
+The <info>%command.name%</info> command lists Cloud Storage HMAC Keys.
 
 <info>php %command.full_name% --help</info>
 
 EOF
     )
-    ->addArgument('projectId', InputArgument::REQUIRED, 'The Cloud Project ID HMAC Keys to list')
+    ->addArgument('projectId', InputArgument::REQUIRED, 'The Cloud Project ID with HMAC Keys to list')
     ->setCode(function ($input, $output) {
         $projectId = $input->getArgument('projectId');
         list_hmac_keys($projectId);
@@ -449,14 +449,14 @@
 $application->add(new Command('hmac-sa-create'))
     ->setDescription('Create a Cloud Storage HMAC Key.')
     ->setHelp(<<<EOF
-The <info>%command.name%</info> command create cloud storage HMAC keys.
+The <info>%command.name%</info> command creates Cloud Storage HMAC Keys.
 
 <info>php %command.full_name% --help</info>
 
 EOF
     )
-    ->addArgument('projectId', InputArgument::REQUIRED, 'The Cloud Project ID of the service account email')
-    ->addArgument('serviceAccountEmail', InputArgument::REQUIRED, 'The service account to associate new HMAC Key')
+    ->addArgument('projectId', InputArgument::REQUIRED, 'The Cloud Project ID associated with the service account email')
+    ->addArgument('serviceAccountEmail', InputArgument::REQUIRED, 'The service account to associate with the new HMAC Key')
     ->setCode(function ($input, $output) {
         $projectId = $input->getArgument('projectId');
         $serviceAccountEmail = $input->getArgument('serviceAccountEmail');
@@ -472,12 +472,12 @@
 
 EOF
     )
-    ->addArgument('projectId', InputArgument::REQUIRED, 'The Cloud Project Id associated to the HMAC key')
-    ->addArgument('accessId', InputArgument::REQUIRED, 'The Cloud Storage HMAC key access Id')
-    ->addOption('activate', null, InputOption::VALUE_NONE, 'Activate an HMAC key')
-    ->addOption('deactivate', null, InputOption::VALUE_NONE, 'Deactivate an HMAC key')
-    ->addOption('get', null, InputOption::VALUE_NONE, 'Get an HMAC key\'s metadata')
-    ->addOption('delete', null, InputOption::VALUE_NONE, 'Delete an HMAC key')
+    ->addArgument('projectId', InputArgument::REQUIRED, 'The Cloud Project ID associated with the HMAC Key')
+    ->addArgument('accessId', InputArgument::REQUIRED, 'The Cloud Storage HMAC Key access ID')
+    ->addOption('activate', null, InputOption::VALUE_NONE, 'Activate an HMAC Key')
+    ->addOption('deactivate', null, InputOption::VALUE_NONE, 'Deactivate an HMAC Key')
+    ->addOption('get', null, InputOption::VALUE_NONE, 'Get an HMAC Key\'s metadata')
+    ->addOption('delete', null, InputOption::VALUE_NONE, 'Delete an HMAC Key')
     ->setCode(function ($input, $output) {
         $projectId = $input->getArgument('projectId');
         $accessId = $input->getArgument('accessId');

storage/test/HmacCommandTest.php

@@ -23,7 +23,7 @@
 use PHPUnit\Framework\TestCase;
 
 /**
- * Unit Tests for BucketPolicyOnlyCommand.
+ * Unit Tests for HmacCommand.
  */
 class HmacCommandTest extends TestCase
 {