From feb894bacd68d705dfaf265c38b39a3b58799a99 Mon Sep 17 00:00:00 2001
From: Riccardo Azzolini <riccardo4096@gmail.com>
Date: Mon, 12 Aug 2019 13:31:37 +0200
Subject: [PATCH] Improve SubFunctionPattern documentation

---
 .../warppi/math/rules/dsl/patterns/SubFunctionPattern.java   | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/core/src/main/java/it/cavallium/warppi/math/rules/dsl/patterns/SubFunctionPattern.java b/core/src/main/java/it/cavallium/warppi/math/rules/dsl/patterns/SubFunctionPattern.java
index 002fc22f..40e0fbb2 100644
--- a/core/src/main/java/it/cavallium/warppi/math/rules/dsl/patterns/SubFunctionPattern.java
+++ b/core/src/main/java/it/cavallium/warppi/math/rules/dsl/patterns/SubFunctionPattern.java
@@ -10,6 +10,11 @@ import java.util.stream.Stream;
 
 /**
  * Matches and generates any function as a named sub-function.
+ * <p>
+ * For a <code>Function</code> to match a <code>Pattern</code>, all <code>SubFunctionPattern</code>s with the same name
+ * must capture equal sub-functions (according to the <code>equals</code> method).
+ * For example, the <code>x + x</code> <code>Pattern</code> matches <code>2 + 2</code> and <code>2 + 2.0</code>,
+ * but not <code>2 + 3</code>, while the <code>x + y</code> <code>Pattern</code> matches all three <code>Function</code>s.
  */
 public class SubFunctionPattern implements Pattern {
 	private final String name;