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-cli.git
The following commit(s) were added to refs/heads/master by this push:
new 4bae1b57 Javadoc
4bae1b57 is described below
commit 4bae1b57749047b5aaa09ad317bb19d25a22be20
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Oct 17 10:21:08 2024 -0400
Javadoc
---
src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java | 4 ++++
1 file changed, 4 insertions(+)
diff --git
a/src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java
b/src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java
index 222ec903..62db4267 100644
--- a/src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java
+++ b/src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java
@@ -28,6 +28,10 @@ import java.io.IOException;
* The class {@code FilterHelpAppendable} itself simply overrides all methods
of {@code HelpAppendable} with versions that pass all requests to the underlying
* appendable. Subclasses of {@code FilterHelpAppendable} may further override
some of these methods as well as provide additional methods and fields.
* </p>
+ * <p>
+ * <em>Implementation Note</em>: This class is similar to FilterOutputStream
in relation to OutputStream. We could further split FilterHelpAppendable into a
+ * FilterAppendable but that seems like YAGNI.
+ * </p>
*
* @since 1.10.0
*/
