Clarify meaning of 'inserted' to be 'inserted before the end of the l…

…ist of existing values'
smithy-lang · Aug 2, 2021 · 08c827a · 08c827a
1 parent cc9ce60
commit 08c827a
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/smithy-diff/src/main/java/software/amazon/smithy/diff/evaluators/ChangedEnumTrait.java b/smithy-diff/src/main/java/software/amazon/smithy/diff/evaluators/ChangedEnumTrait.java
@@ -31,7 +31,8 @@
 /**
  * Emits a NOTE when a new enum value is appended, emits an ERROR when an
  * enum value is removed, emits an ERROR when an enum name changes, and
- * emits an ERROR when a new enum value is inserted.
+ * emits an ERROR when a new enum value is inserted before the end of the
+ * list of existing values.
  */
 public final class ChangedEnumTrait extends AbstractDiffEvaluator {
     @Override
@@ -75,8 +76,9 @@ private List<ValidationEvent> validateEnum(ChangedShape<Shape> change, Pair<Enum
             if (!oldTrait.getEnumDefinitionValues().contains(definition.getValue())) {
                 if (newPosition <= oldEndPosition) {
                     events.add(error(change.getNewShape(), String.format(
-                            "Enum value `%s` was inserted. This can cause compatibility issues when ordinal values are "
-                                    + "used for iteration, serialization, etc.", definition.getValue())));
+                            "Enum value `%s` was inserted before the end of the list of existing values. This can "
+                                    + "cause compatibility issues when ordinal values are used for iteration, "
+                                    + "serialization, etc.", definition.getValue())));
                 } else {
                     events.add(note(change.getNewShape(), String.format(
                             "Enum value `%s` was appended", definition.getValue())));