From 342deaad6cf5ad68db5e2d1523a3438167ee3ebf Mon Sep 17 00:00:00 2001
From: Antonio Velazquez <anvelazq@microsoft.com>
Date: Fri, 10 Jul 2020 14:43:16 -0700
Subject: [PATCH] Improve VectorTypeAttribute(dimensions) docs

---
 src/Microsoft.ML.Data/Data/SchemaDefinition.cs | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/Microsoft.ML.Data/Data/SchemaDefinition.cs b/src/Microsoft.ML.Data/Data/SchemaDefinition.cs
index 8933690f2c..df47f535e9 100644
--- a/src/Microsoft.ML.Data/Data/SchemaDefinition.cs
+++ b/src/Microsoft.ML.Data/Data/SchemaDefinition.cs
@@ -80,7 +80,9 @@ public VectorTypeAttribute(int size)
         }
 
         /// <summary>
-        /// Mark member with expected dimensions of array.
+        /// Mark member with expected dimensions of array. Notice that this attribute is expected to be added to one dimensional arrays,
+        /// and it shouldn't be added to multidimensional arrays. Internally, ML.NET will use the shape information provided as the
+        /// "dimensions" param of this constructor, to use it as a multidimensional array.
         /// </summary>
         /// <param name="dimensions">Dimensions of array. All values should be non-negative.
         /// A zero value indicates that the vector type is considered to have unknown length along that dimension.</param>