HPCC-31297 Fix documentation for SKEW limit defaults

Signed-off-by: Jim DeFabia <[email protected]>
hpcc-systems · Feb 16, 2024 · 2dcdb92 · 2dcdb92
1 parent 4a7774d
commit 2dcdb92
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 9 deletions.
diff --git a/docs/EN_US/ECLLanguageReference/ECLR_mods/BltInFunc-DISTRIBUTE.xml b/docs/EN_US/ECLLanguageReference/ECLR_mods/BltInFunc-DISTRIBUTE.xml
@@ -104,16 +104,19 @@
           <row>
             <entry><emphasis>maxskew</emphasis></entry>
 
-            <entry>A floating point number in the range of zero (0.0) to one
-            (1.0) specifying the minimum skew to allow (0.1=10%).</entry>
+            <entry>A value between zero (0) and one (1.0 = 100%) indicating
+            the maximum percentage of skew to allow before the job fails (the
+            default skew is 1.0 / &lt;number of worker nodes on
+            cluster&gt;).</entry>
           </row>
 
           <row>
             <entry><emphasis>skewlimit</emphasis></entry>
 
-            <entry>Optional. A floating point number in the range of zero
-            (0.0) to one (1.0) specifying the maximum skew to allow
-            (0.1=10%).</entry>
+            <entry>Optional. A value between zero (0) and one (1.0 = 100%)
+            indicating the desired maximum percentage of skew to allow (the
+            default skew is 1.0 / &lt;number of worker nodes on
+            cluster&gt;).</entry>
           </row>
 
           <row>

diff --git a/docs/EN_US/ECLLanguageReference/ECLR_mods/BltInFunc-JOIN.xml b/docs/EN_US/ECLLanguageReference/ECLR_mods/BltInFunc-JOIN.xml
@@ -534,15 +534,17 @@
 
             <entry>A value between zero (0) and one (1.0 = 100%) indicating
             the maximum percentage of skew to allow before the job fails (the
-            default is 0.1 = 10%).</entry>
+            default skew is 1.0 / &lt;number of worker nodes on
+            cluster&gt;).</entry>
           </row>
 
           <row>
             <entry><emphasis>target</emphasis></entry>
 
             <entry>Optional. A value between zero (0) and one (1.0 = 100%)
             indicating the desired maximum percentage of skew to allow (the
-            default is 0.1 = 10%).</entry>
+            default skew is 1.0 / &lt;number of worker nodes on
+            cluster&gt;).</entry>
           </row>
 
           <row>

diff --git a/docs/EN_US/ECLLanguageReference/ECLR_mods/BltInFunc-SORT.xml b/docs/EN_US/ECLLanguageReference/ECLR_mods/BltInFunc-SORT.xml
@@ -102,15 +102,17 @@
 
             <entry>A value between zero (0) and one (1.0 = 100%) indicating
             the maximum percentage of skew to allow before the job fails (the
-            default is 0.1 = 10%).</entry>
+            default skew is 1.0 / &lt;number of worker nodes on
+            cluster&gt;).</entry>
           </row>
 
           <row>
             <entry><emphasis>target</emphasis></entry>
 
             <entry>Optional. A value between zero (0) and one (1.0 = 100%)
             indicating the desired maximum percentage of skew to allow (the
-            default is 0.1 = 10%).</entry>
+            default skew is 1.0 / &lt;number of worker nodes on
+            cluster&gt;).</entry>
           </row>
 
           <row>