Adds usage examples to api-client samples and fixes copy/paste error …

…in cloud-client/transcribe. (#782)
GoogleCloudPlatform · Feb 3, 2017 · 66b23ee · 66b23ee
1 parent 0aee13b
commit 66b23ee
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 6 deletions.
diff --git a/speech/api-client/README.rst b/speech/api-client/README.rst
@@ -83,6 +83,11 @@ To run this sample:
 
     usage: transcribe.py [-h] speech_file
     
+    Google Cloud Speech API sample application using the REST API for batch
+    processing.
+    
+    Example usage: python transcribe.py resources/audio.raw
+    
     positional arguments:
       speech_file  Full path of audio file to be recognized
     
@@ -103,6 +108,11 @@ To run this sample:
 
     usage: transcribe_async.py [-h] speech_file
     
+    Google Cloud Speech API sample application using the REST API for async
+    batch processing.
+    
+    Example usage: python transcribe.py resources/audio.raw
+    
     positional arguments:
       speech_file  Full path of audio file to be recognized
     

diff --git a/speech/api-client/transcribe.py b/speech/api-client/transcribe.py
@@ -13,7 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Google Cloud Speech API sample application using the REST API for batch
-processing."""
+processing.
+
+Example usage: python transcribe.py resources/audio.raw
+"""
 
 # [START import_libraries]
 import argparse
@@ -89,7 +92,9 @@ def main(speech_file):
 
 # [START run_application]
 if __name__ == '__main__':
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(
+        description=__doc__,
+        formatter_class=argparse.RawDescriptionHelpFormatter)
     parser.add_argument(
         'speech_file', help='Full path of audio file to be recognized')
     args = parser.parse_args()

diff --git a/speech/api-client/transcribe_async.py b/speech/api-client/transcribe_async.py
@@ -13,7 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Google Cloud Speech API sample application using the REST API for async
-batch processing."""
+batch processing.
+
+Example usage: python transcribe.py resources/audio.raw
+"""
 
 # [START import_libraries]
 import argparse
@@ -101,7 +104,9 @@ def main(speech_file):
 
 # [START run_application]
 if __name__ == '__main__':
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(
+        description=__doc__,
+        formatter_class=argparse.RawDescriptionHelpFormatter)
     parser.add_argument(
         'speech_file', help='Full path of audio file to be recognized')
     args = parser.parse_args()

diff --git a/speech/cloud-client/README.rst b/speech/cloud-client/README.rst
@@ -98,7 +98,7 @@ To run this sample:
     Google Cloud Speech API sample application using the REST API for batch
     processing.
     
-    Example usage: python translate.py resources/audio.raw
+    Example usage: python transcribe.py resources/audio.raw
     
     positional arguments:
       speech_file  Full path of audio file to be recognized

diff --git a/speech/cloud-client/transcribe.py b/speech/cloud-client/transcribe.py
@@ -17,7 +17,7 @@
 """Google Cloud Speech API sample application using the REST API for batch
 processing.
 
-Example usage: python translate.py resources/audio.raw
+Example usage: python transcribe.py resources/audio.raw
 """
 
 # [START import_libraries]