Fix spelling errors in Schema Registry (#33635)

* Adding apacheavro to ignore list. It is correct. * Fixing spelling mistakes. * Fixing spelling mistakes in cache. remove alias.
Azure · Feb 21, 2023 · 578256e · 578256e
1 parent 6873c9c
commit 578256e
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 10 deletions.
diff --git a/.vscode/cspell.json b/.vscode/cspell.json
@@ -172,8 +172,6 @@
     "sdk/purview/azure-analytics-purview-workflow/**",
     "sdk/remoterendering/TestResources/**",
     "sdk/purview/azure-analytics-purview-catalog/**",
-    "sdk/schemaregistry/azure-data-schemaregistry/**",
-    "sdk/schemaregistry/azure-data-schemaregistry-apacheavro/**",
     "sdk/servicebus/build/**",
     "sdk/search/azure-search-documents/**",
     "sdk/storage/azure-storage-internal-avro/**",
@@ -209,6 +207,7 @@
     "amqp",
     "Amqp",
     "AMQP",
+    "apacheavro",
     "Apim",
     "AUHours",
     "autoscale",
@@ -329,6 +328,7 @@
     "runtimes",
     "SBOM",
     "scalastyle",
+    "schemaregistryapacheavroserializer",
     "servicebus",
     "skus",
     "sonatype",

diff --git a/...ain/java/com/azure/data/schemaregistry/apacheavro/SchemaRegistryApacheAvroSerializer.java b/...ain/java/com/azure/data/schemaregistry/apacheavro/SchemaRegistryApacheAvroSerializer.java
@@ -66,7 +66,7 @@
  * &#47;&#47;   ]
  * &#47;&#47; &#125;
  * Person person = Person.newBuilder&#40;&#41;
- *     .setName&#40;&quot;Alina&quot;&#41;
+ *     .setName&#40;&quot;Chase&quot;&#41;
  *     .setFavouriteColour&#40;&quot;Turquoise&quot;&#41;
  *     .build&#40;&#41;;
  *
@@ -107,7 +107,7 @@
  * &#47;&#47;   ]
  * &#47;&#47; &#125;
  * Person person = Person.newBuilder&#40;&#41;
- *     .setName&#40;&quot;Alina&quot;&#41;
+ *     .setName&#40;&quot;Chase&quot;&#41;
  *     .setFavouriteColour&#40;&quot;Turquoise&quot;&#41;
  *     .build&#40;&#41;;
  *

diff --git a/...vro/src/main/java/com/azure/data/schemaregistry/apacheavro/SchemaRegistrySchemaCache.java b/...vro/src/main/java/com/azure/data/schemaregistry/apacheavro/SchemaRegistrySchemaCache.java
@@ -150,7 +150,7 @@ private void logCacheStatus() {
 
     /**
      * Simple LRU cache. Accesses to cache are synchronized via the outer class lock.
-     * TODO (conniey): When https://github.com/Azure/azure-sdk-for-java/pull/27408/ is merged, take a look at replacing.
+     * TODO: When https://github.com/Azure/azure-sdk-for-java/pull/27408/ is merged, take a look at replacing.
      */
     private static final class SchemaCache extends LinkedHashMap<String, Schema> {
         private static final long serialVersionUID = -1L;

diff --git a/...istry-apacheavro/src/main/java/com/azure/data/schemaregistry/apacheavro/package-info.java b/...istry-apacheavro/src/main/java/com/azure/data/schemaregistry/apacheavro/package-info.java
@@ -1,5 +1,4 @@
 /**
  * Package containing Avro-specific serializer and deserializer implementations.
- * Also contains the Avro codec utility classes required for all serde operations.
  */
 package com.azure.data.schemaregistry.apacheavro;
diff --git a/.../data/schemaregistry/apacheavro/SchemaRegistryApacheAvroSerializerJavaDocCodeSamples.java b/.../data/schemaregistry/apacheavro/SchemaRegistryApacheAvroSerializerJavaDocCodeSamples.java
@@ -65,7 +65,7 @@ public void serialize() {
         //   ]
         // }
         Person person = Person.newBuilder()
-            .setName("Alina")
+            .setName("Chase")
             .setFavouriteColour("Turquoise")
             .build();
 
@@ -91,7 +91,7 @@ public void serializeMessageFactory() {
         //   ]
         // }
         Person person = Person.newBuilder()
-            .setName("Alina")
+            .setName("Chase")
             .setFavouriteColour("Turquoise")
             .build();
 

diff --git a/sdk/schemaregistry/azure-data-schemaregistry/README.md b/sdk/schemaregistry/azure-data-schemaregistry/README.md
@@ -1,7 +1,7 @@
 # Azure Schema Registry client library for Java
 
 Azure Schema Registry is a schema repository service hosted by Azure Event Hubs, providing schema storage, versioning,
-and management. The registry is leveraged by serializers to reduce payload size while describing payload structure with
+and management. The registry is leveraged by applications to reduce payload size while describing payload structure with
 schema identifiers rather than full schemas.
 
 [Source code][source_code] | [Package (Maven)][package_maven] | [API reference documentation][api_reference_doc] | [Product Documentation][product_documentation] | [Samples][sample_readme]

diff --git a/...emaregistry/src/main/java/com/azure/data/schemaregistry/SchemaRegistryJsonSerializer.java b/...emaregistry/src/main/java/com/azure/data/schemaregistry/SchemaRegistryJsonSerializer.java
@@ -56,7 +56,6 @@ public String serializeList(List<?> list, CollectionFormat format) {
      */
     @Override
     public <T> T deserialize(String value, Type type, SerializerEncoding encoding) throws IOException {
-        //TODO (conniey): Test this.
         return adapter.deserialize(value, type, encoding);
     }