fix spelling

vectordotdev · Jul 3, 2024 · 00a3f65 · 00a3f65
1 parent 103be07
commit 00a3f65
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/changelog.d/18669_csv_docu_u8_display.fix.md → ...18669_csv_documentation_u8_display.fix.md b/changelog.d/18669_csv_docu_u8_display.fix.md → ...18669_csv_documentation_u8_display.fix.md
diff --git a/scripts/generate-component-docs.rb b/scripts/generate-component-docs.rb
@@ -745,10 +745,11 @@ def resolve_schema(root_schema, schema)
   # We intentially set no actual definition for these types, relying on the documentation generation
   # process to provide the actual details. We only need to specify the custom type name.
   #
-  # To handle u8 types as ascii characters and not there uint represeentation between 0 and 255 we
+  # To handle u8 types as ascii characters and not there uint representation between 0 and 255 we
   # added a special handling of these exact values. This means
-  # `#[configurable(metadata(docs::type_override = "ascii_char"))]` should only be used for rust
-  # u8 type. See lib/codecs/src/encoding/format/csv.rs for an exmaple.
+  # `#[configurable(metadata(docs::type_override = "ascii_char"))]` should only be used consciously
+  # for rust u8 type. See lib/codecs/src/encoding/format/csv.rs for an example and
+  # https://github.com/vectordotdev/vector/pull/20498
   type_override = get_schema_metadata(schema, 'docs::type_override')
   if !type_override.nil?
     if type_override == 'ascii_char'