This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-collections.git
The following commit(s) were added to refs/heads/master by this push:
new f84c8d6ea Emphasize "should" a la rfc2119
f84c8d6ea is described below
commit f84c8d6ea124f41cc8077fafde012fdc1bed6b4b
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Jul 10 08:33:06 2024 -0400
Emphasize "should" a la rfc2119
---
src/main/java/org/apache/commons/collections4/Transformer.java | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/Transformer.java
b/src/main/java/org/apache/commons/collections4/Transformer.java
index 221b95729..52bb97c10 100644
--- a/src/main/java/org/apache/commons/collections4/Transformer.java
+++ b/src/main/java/org/apache/commons/collections4/Transformer.java
@@ -23,7 +23,7 @@ import java.util.function.Function;
* object into another.
* <p>
* A {@code Transformer} converts the input object to the output object.
- * The input object should be left unchanged.
+ * The input object SHOULD be left unchanged.
* Transformers are typically used for type conversions, or extracting data
* from an object.
* </p>
@@ -49,7 +49,10 @@ public interface Transformer<T, R> extends Function<T, R> {
}
/**
- * Transforms the input object (leaving it unchanged) into some output
object.
+ * Transforms the input object into some output object.
+ * <p>
+ * The input object SHOULD be left unchanged.
+ * </p>
*
* @param input the object to be transformed, should be left unchanged
* @return a transformed object
