docs: fix minor typos (#2318)

Author: parthea

gapic/configurable_snippetgen/snippet_config_language.proto

@@ -167,7 +167,7 @@ message SnippetSignature {
 
     // Languages that support both async and sync methods should generate both a
     // sync and an async snippets. Note that different samples should be in
-    // differnt files.
+    // different files.
     // Languages that support only one of async and sync methods should
     // generate the supported snippet.
     BOTH = 3;
@@ -494,7 +494,7 @@ message Snippet {
   // Describes how to handle LRO responses.
   message LroResponseHandling {
     // The name of the variable to capture the LRO response in. Required.
-    // This will capture the response to the LRO operaion call and not to
+    // This will capture the response to the LRO operation call and not to
     // polling operations.
     string response_name = 1;
 
@@ -556,7 +556,7 @@ message Statement {
     // An iteration statement. A given Statement set will be executed
     // repeatedly according to the iteration definition.
     // Each iteration type will make a per-step Expression.NameValue set
-    // available that may be used withing the given Statement set.
+    // available that may be used within the given Statement set.
     Iteration iteration = 5;
   }
 
@@ -617,7 +617,7 @@ message Statement {
   // An iteration statement. A given Statement set will be executed
   // repeatedly according to the iteration definition.
   // Each iteration type will make a per-step Expression.NameValue set
-  // available that may be used withing the given Statement set.
+  // available that may be used within the given Statement set.
   message Iteration {
     oneof iteration_type {
       // A numeric sequence iteration.
@@ -642,7 +642,7 @@ message Statement {
     // Represents a numeric sequence iteration.
     // A numeric sequence is defined over which to iterate making the current
     // element of the sequence available in a variable.
-    // It's ultimately the responsability of the user to define a finite
+    // It's ultimately the responsibility of the user to define a finite
     // sequence, although tooling may be provided to help.
     message NumericSequenceIteration {
       // Where to start the sequence at, ie. the first element of the iteration.
@@ -740,7 +740,7 @@ message Statement {
 
       // How to split the byte sequence in chunks to iterate over.
       oneof chunk {
-        // The size of the chuncks to split the byte sequence in. The last chunk
+        // The size of the chunks to split the byte sequence in. The last chunk
         // will be at most chunk_size. Must be positive.
         // Should resolve to an integer type.
         Expression chunk_size = 2;
@@ -1010,7 +1010,7 @@ message Expression {
     // and a Declaration of
     // - Declaration.type => SampleMessage and
     // - Declaration.name => sample_value
-    // then posible NameValues that refer to the variable declared are:
+    // then possible NameValues that refer to the variable declared are:
     // - NameValue.name => sample_value and NameValue.path => unset to reference
     //   the value of the sample_value variable, i.e. using the variable
     //   sample_value

gapic/configurable_snippetgen/snippet_config_language_pb2.pyi

@@ -243,7 +243,7 @@ class SnippetSignature(google.protobuf.message.Message):
         BOTH: SnippetSignature._SyncPreference.ValueType  # 3
         """Languages that support both async and sync methods should generate both a
         sync and an async snippets. Note that different samples should be in
-        differnt files.
+        different files.
         Languages that support only one of async and sync methods should
         generate the supported snippet.
         """
@@ -271,7 +271,7 @@ class SnippetSignature(google.protobuf.message.Message):
     BOTH: SnippetSignature.SyncPreference.ValueType  # 3
     """Languages that support both async and sync methods should generate both a
     sync and an async snippets. Note that different samples should be in
-    differnt files.
+    different files.
     Languages that support only one of async and sync methods should
     generate the supported snippet.
     """
@@ -919,7 +919,7 @@ class Snippet(google.protobuf.message.Message):
         POLLING_CALL_FIELD_NUMBER: builtins.int
         response_name: builtins.str
         """The name of the variable to capture the LRO response in. Required.
-        This will capture the response to the LRO operaion call and not to
+        This will capture the response to the LRO operation call and not to
         polling operations.
         """
         polling_type: global___Snippet.LroResponseHandling.PollingType.ValueType
@@ -1154,7 +1154,7 @@ class Statement(google.protobuf.message.Message):
         """An iteration statement. A given Statement set will be executed
         repeatedly according to the iteration definition.
         Each iteration type will make a per-step Expression.NameValue set
-        available that may be used withing the given Statement set.
+        available that may be used within the given Statement set.
         """
 
         DESCRIPTOR: google.protobuf.descriptor.Descriptor
@@ -1164,7 +1164,7 @@ class Statement(google.protobuf.message.Message):
             """Represents a numeric sequence iteration.
             A numeric sequence is defined over which to iterate making the current
             element of the sequence available in a variable.
-            It's ultimately the responsability of the user to define a finite
+            It's ultimately the responsibility of the user to define a finite
             sequence, although tooling may be provided to help.
             """
 
@@ -1336,7 +1336,7 @@ class Statement(google.protobuf.message.Message):
                 """
             @property
             def chunk_size(self) -> global___Expression:
-                """The size of the chuncks to split the byte sequence in. The last chunk
+                """The size of the chunks to split the byte sequence in. The last chunk
                 will be at most chunk_size. Must be positive.
                 Should resolve to an integer type.
                 """
@@ -1432,7 +1432,7 @@ class Statement(google.protobuf.message.Message):
         """An iteration statement. A given Statement set will be executed
         repeatedly according to the iteration definition.
         Each iteration type will make a per-step Expression.NameValue set
-        available that may be used withing the given Statement set.
+        available that may be used within the given Statement set.
         """
     def __init__(
         self,
@@ -1814,7 +1814,7 @@ class Expression(google.protobuf.message.Message):
             and a Declaration of
             - Declaration.type => SampleMessage and
             - Declaration.name => sample_value
-            then posible NameValues that refer to the variable declared are:
+            then possible NameValues that refer to the variable declared are:
             - NameValue.name => sample_value and NameValue.path => unset to reference
               the value of the sample_value variable, i.e. using the variable
               sample_value

gapic/samplegen/samplegen.py

@@ -302,7 +302,7 @@ def preprocess_sample(sample, api_schema: api.API, rpc: wrappers.Method):
         is_async = transport == api.TRANSPORT_GRPC_ASYNC
         sample["client_name"] = service.async_client_name if is_async else service.client_name
 
-        # the MessageType of the request object passed to the rpc e.g, `ListRequest`
+        # the MessageType of the request object passed to the rpc e.g., `ListRequest`
         sample["request_type"] = rpc.input
 
         # We check if the request object is part of the service proto package.
@@ -744,7 +744,7 @@ def _validate_format(self, body: List[str]):
         num_prints = fmt_str.count("%s")
         if num_prints != len(body) - 1:
             raise types.MismatchedFormatSpecifier(
-                "Expected {} expresssions in format string '{}' but found {}".format(
+                "Expected {} expressions in format string '{}' but found {}".format(
                     num_prints, fmt_str, len(body) - 1
                 )
             )
@@ -821,7 +821,7 @@ def _validate_loop(self, loop):
         Checks for correctly defined loop constructs,
         either 'collection' loops with a collection and iteration variable,
         or 'map' loops with a map and at least one of 'key' or 'value'.
-        Loops also have a 'body', which contains statments that may
+        Loops also have a 'body', which contains statements that may
         use the variables from the header.
 
         The body statements are validated recursively.

gapic/samplegen_utils/snippet_metadata.proto

@@ -61,13 +61,13 @@ message Snippet {
   // may be written in F# or VB .NET.
   // Note that this does not contain information about the snippet supported
   // platforms or language versions, etc. This is just a quick way to identify
-  // the generally supported langauge.
+  // the generally supported language.
   Language language = 5;
 
   // The client library method this snippet is for.
   ClientMethod client_method = 6;
 
-  // Wether this is the canonical snippet for the corresponding service method.
+  // Whether this is the canonical snippet for the corresponding service method.
   // This is to be interpreted in conjunction with origin as follows:
   // For a given service method:
   // - A handwritten canonical takes precedence over
@@ -128,7 +128,7 @@ message Snippet {
       FULL = 1;
 
       // A shorter version of the full sample, may not include imports and some
-      // langauge specific initialization code. This is to be used in contexts
+      // language specific initialization code. This is to be used in contexts
       // in which the full aspects of the sample are made clear outside the
       // code.
       SHORT = 2;
@@ -166,7 +166,7 @@ message ClientMethod {
   // This may not be unique within the service client because of overloads.
   string full_name = 2;
 
-  // Indicates wether this method is synchronous or asynchronous.
+  // Indicates whether this method is synchronous or asynchronous.
   // Some languages may support only one of the variants, in which case, this
   // field will always have the same value (for that language).
   bool async = 3;
@@ -205,7 +205,7 @@ message ServiceClient {
 
   // The fully qualified name of the service client, which is the short_name
   // qualified by the namespace/package/type name this client is declared in.
-  // This will be unique within the client libray.
+  // This will be unique within the client library.
   string full_name = 2;
 }
 
@@ -228,7 +228,7 @@ message ClientLibrary {
   // The programming language the library is written in.
   // Note that this does not contain information about the library supported
   // platforms or language versions, etc. This is just a quick way to identify
-  // the generally supported langauge.
+  // the generally supported language.
   Language language = 3;
 
   // The APIs this client library is for.

gapic/schema/naming.py

@@ -34,7 +34,7 @@ class Naming(abc.ABC):
     This class contains the naming nomenclature used for this API
     within templates.
 
-    An concrete child of this object is made available to every template
+    A concrete child of this object is made available to every template
     (as ``api.naming``).
     """
     name: str = ''

gapic/schema/wrappers.py

@@ -218,7 +218,7 @@ def inner_mock(self, stack, visited_fields) -> str:
             answer = f'{self.type.ident}({sub.name}={{}})'
 
         if self.map:
-            # Maps are a special case beacuse they're represented internally as
+            # Maps are a special case because they're represented internally as
             # a list of a generated type with two fields: 'key' and 'value'.
             answer = '{{{}: {}}}'.format(
                 self.type.fields["key"].mock_value,

tests/unit/samplegen/test_snippet_index.py

@@ -80,7 +80,7 @@ def test_snippet_init(sample_str):
 
     # This is the same as the sample_str above, minus the # [START ...]
     # and # [END ...] lines
-    expected_full_snipppet = """from molluscs.v1 import molluscclient
+    expected_full_snippet = """from molluscs.v1 import molluscclient
 
 
 def sample_classify(video, location):
@@ -109,7 +109,7 @@ def sample_classify(video, location):
 
 """
 
-    assert snippet.full_snippet == expected_full_snipppet
+    assert snippet.full_snippet == expected_full_snippet
 
 
 def test_add_snippet_no_matching_service(sample_str):

tests/unit/schema/test_api.py

@@ -3482,7 +3482,7 @@ def make_initiate_options(service_name):
                 make_message_pb2(name='CreateBarRequest'),
                 make_message_pb2(name='GetBarOperationRequest'),
                 make_message_pb2(name='PoorlyOrganizedMethodRequest'),
-                make_message_pb2(name='PoorlyOrganizedMethodReponse')
+                make_message_pb2(name='PoorlyOrganizedMethodResponse')
             ),
             services=(
                 descriptor_pb2.ServiceDescriptorProto(
@@ -3497,7 +3497,7 @@ def make_initiate_options(service_name):
                         descriptor_pb2.MethodDescriptorProto(
                             name='PoorlyOrganizedMethod',
                             input_type='google.example.v1.PoorlyOrganizedMethodRequest',
-                            output_type='google.example.v1.PoorlyOrganizedMethodReponse',
+                            output_type='google.example.v1.PoorlyOrganizedMethodResponse',
                         ),
                     ),
                 ),

tests/unit/schema/wrappers/test_message.py

@@ -151,7 +151,7 @@ def test_get_field_recursive():
     outer_field = make_field('inner', message=inner)
     outer = make_message('Outer', fields=(outer_field,))
 
-    # Assert that a recusive retrieval works.
+    # Assert that a recursive retrieval works.
     assert outer.get_field('inner', 'zero') == inner_fields[0]
     assert outer.get_field('inner', 'one') == inner_fields[1]
     assert outer.get_field('inner.one') == inner_fields[1]
@@ -166,7 +166,7 @@ def test_get_field_nested_not_found_error():
     outer_field = make_field('inner', message=inner)
     outer = make_message('Outer', fields=(outer_field,))
 
-    # Assert that a recusive retrieval fails.
+    # Assert that a recursive retrieval fails.
     with pytest.raises(KeyError):
         assert outer.get_field('inner', 'zero', 'beyond')
 
@@ -180,7 +180,7 @@ def test_get_field_nonterminal_repeated_error():
     outer_field = make_field('inner', message=inner, repeated=True)
     outer = make_message('Outer', fields=(outer_field,))
 
-    # Assert that a recusive retrieval fails.
+    # Assert that a recursive retrieval fails.
     with pytest.raises(KeyError):
         assert outer.get_field('inner', 'zero') == inner_fields[0]
     with pytest.raises(KeyError):
@@ -309,7 +309,7 @@ def test_oneof_fields():
     length_f = make_field(name="length_f", oneof="length", type=5)
     color = make_field(name="color", type=5)
     request = make_message(
-        name="CreateMolluscReuqest",
+        name="CreateMolluscRequest",
         fields=(
             mass_kg,
             mass_lbs,
@@ -345,7 +345,7 @@ def test_required_fields():
     )
 
     request = make_message(
-        name="CreateMolluscReuqest",
+        name="CreateMolluscRequest",
         fields=(
             mass_kg,
             length_m,

tests/unit/schema/wrappers/test_method.py

@@ -801,7 +801,7 @@ def test_flattened_oneof_fields():
         ),
     )
     request = make_message(
-        name="CreateMolluscReuqest",
+        name="CreateMolluscRequest",
         fields=(
             length_m,
             length_f,
@@ -825,7 +825,7 @@ def test_flattened_oneof_fields():
     actual = method.flattened_oneof_fields()
     assert expected == actual
 
-    # Check this method too becasue the setup is a lot of work.
+    # Check this method too because the setup is a lot of work.
     expected = {
         "color": "color",
         "length_m": "length_m",