[Bf-blender-cvs] [736b6a70a49] master: Docs: improve word wrap comment

[Campbell Barton]

Commit: 736b6a70a492e35c2be9e1f6bb6b26a057fbdf58
Author: Campbell Barton
Date:   Tue Aug 17 15:11:54 2021 +1000
Branches: master
https://developer.blender.org/rB736b6a70a492e35c2be9e1f6bb6b26a057fbdf58

Docs: improve word wrap comment

===================================================================

M	source/blender/blenkernel/intern/font.c

===================================================================

diff --git a/source/blender/blenkernel/intern/font.c b/source/blender/blenkernel/intern/font.c
index de838f1b3cd..72add476bfe 100644
--- a/source/blender/blenkernel/intern/font.c
+++ b/source/blender/blenkernel/intern/font.c
@@ -716,8 +716,10 @@ typedef struct VFontToCurveIter {
   } bisect;
   bool ok;
   /**
-   * Disables checking if word wrapping is needed to fit the text-box width.
-   * Currently only used when scale-to-fit is enabled.
+   * Wrap words that extends beyond the text-box width (enabled by default).
+   *
+   * Currently only disabled when scale-to-fit is enabled,
+   * so floating-point error doesn't cause unexpected wrapping, see T89241.
    */
   bool word_wrap;
   int status;