Fix small problems in README.md (#3)

bakdata · Mar 1, 2023 · 452ed38 · 452ed38
1 parent a5baaf3
commit 452ed38
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -35,9 +35,9 @@ It converts the value to a string schema.
 
 #### Properties
 
-| Name        | Description                  | Type  | Default                  | Valid Values                                                                                                                                    | Importance |
-|-------------|------------------------------|-------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|------------|
-| `converter` | Converter to apply to input. | class | ByteArrayConverter.class | All classes that implement the [Kafka Converter interface](https://kafka.apache.org/34/javadoc/org/apache/kafka/connect/storage/Converter.html) | high       |
+| Name        | Description                  | Type  | Default                    | Valid Values                                                                                                                                    | Importance |
+|-------------|------------------------------|-------|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|------------|
+| `converter` | Converter to apply to input. | class | `ByteArrayConverter.class` | All classes that implement the [Kafka Converter interface](https://kafka.apache.org/34/javadoc/org/apache/kafka/connect/storage/Converter.html) | high       |
 
 ### Drop field
 
@@ -108,9 +108,9 @@ The value would transform into this:
 
 #### Properties
 
-| Name      | Description                              | Type   | Default | Valid Values                                              | Importance |
-|-----------|------------------------------------------|--------|---------|-----------------------------------------------------------|------------|
-| `exclued` | Field to path from the resulting Struct. | string | -       | The path is separated by "." character. Example: `a.b.c`. | high       |
+| Name      | Description                                         | Type     | Default | Valid Values                                              | Importance |
+|-----------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------|------------|
+| `exclude` | Path to field to exclude from the resulting Struct. | `string` | -       | The path is separated by "." character. Example: `a.b.c`. | high       |
 
 ## Installation
 
@@ -137,9 +137,8 @@ If you want to contribute to this project, you can simply clone the repository a
 All dependencies should be included in the Gradle files, there are no external prerequisites.
 
 ```bash
-clone >git git@github.com:bakdata/kafka-connect-plugins.git
-kafka-connect-plugins >cd && ./gradlew build
-
+> git clone git@github.com:bakdata/kafka-connect-plugins.git
+> cd kafka-connect-plugins && ./gradlew build
 ```
 
 Please note, that we have [code styles](https://github.com/bakdata/bakdata-code-styles) for Java.

diff --git a/src/main/java/com/bakdata/kafka/DropField.java b/src/main/java/com/bakdata/kafka/DropField.java
@@ -51,7 +51,7 @@
 public abstract class DropField<R extends ConnectRecord<R>> implements Transformation<R> {
     public static final String EXCLUDE_FIELD = "exclude";
     private static final String PURPOSE = "field deletion";
-    private static final String FIELD_DOCUMENTATION = "Fields to exclude from the resulting Struct.";
+    private static final String FIELD_DOCUMENTATION = "Path to field to exclude from the resulting Struct.";
     private static final ConfigDef CONFIG_DEF = new ConfigDef()
         .define(EXCLUDE_FIELD, Type.STRING, ConfigDef.NO_DEFAULT_VALUE, Importance.HIGH, FIELD_DOCUMENTATION);
     private static final Set<Schema> STRING_SCHEMA = Set.of(Schema.OPTIONAL_STRING_SCHEMA, Schema.STRING_SCHEMA);