From 84037373fb78875d43c3de69f7c114aa81674cbe Mon Sep 17 00:00:00 2001
From: github-actions <github-actions@github.com>
Date: Wed, 10 Jan 2024 08:06:51 +0000
Subject: [PATCH] Update documentation for branch main

---
 main/footer.js                | 4 ++--
 main/group__float__to__x.html | 4 +++-
 version.js                    | 2 +-
 3 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/main/footer.js b/main/footer.js
index 69ed4475..022ad6ec 100644
--- a/main/footer.js
+++ b/main/footer.js
@@ -1,7 +1,7 @@
 function writeHeader() {
-    document.write('Version 1.15.1-dev17');
+    document.write('Version 1.15.1-dev18');
 };
 
 function writeFooter()  {
-    document.write('Generated on Wed Jan 10 2024 07:33:19 for CMSIS-DSP 1.15.1-dev17+g91e83cb. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
+    document.write('Generated on Wed Jan 10 2024 08:06:20 for CMSIS-DSP 1.15.1-dev18+g4acfef7. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
 };
diff --git a/main/group__float__to__x.html b/main/group__float__to__x.html
index a894eead..0564ea7a 100644
--- a/main/group__float__to__x.html
+++ b/main/group__float__to__x.html
@@ -338,7 +338,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaae21be47db707e79552f3e8
     pDst[n] = (q31_t)(pSrc[n] * 2147483648);   0 &lt;= n &lt; blockSize.
 </pre></dd></dl>
 <dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q31 range[0x80000000 0x7FFFFFFF] are saturated.</dd></dl>
-<dl class="section note"><dt>Note</dt><dd>In order to apply rounding, the library should be rebuilt with the ROUNDING macro defined in the preprocessor section of project options. </dd></dl>
+<dl class="section note"><dt>Note</dt><dd>In order to apply rounding, the library should be rebuilt with the ROUNDING macro defined in the preprocessor section of project options.</dd>
+<dd>
+If the input float values are very big (2**32) then the function won't be able to saturate to the right values. If you expect very big float values in the input array then you should force those values to +1 or -1 before calling this function. For reasonable float values (&lt; 2**32), the function will saturate correctly. </dd></dl>
 
 </div>
 </div>
diff --git a/version.js b/version.js
index e7d02cf8..912060c7 100644
--- a/version.js
+++ b/version.js
@@ -1,6 +1,6 @@
 //--- list of versions ---
 const versions = {
-    "main": "1.15.1-dev17",
+    "main": "1.15.1-dev18",
     "latest": "1.15.0",
     "v1.14.4": "1.14.4",
     "v1.14.3": "1.14.3",