Clarify in FloatProperty generated docs: single precision floats.
authorHoward Trickey <howard.trickey@gmail.com>
Wed, 31 Jul 2019 17:58:09 +0000 (13:58 -0400)
committerHoward Trickey <howard.trickey@gmail.com>
Wed, 31 Jul 2019 18:01:42 +0000 (14:01 -0400)
At least one script writer was upset that this was not specified,
as it is different from "floating point" in Python.
Also, docstring for hard and soft min and max for FloatProperty
was wrong, using sys.float_info.min and sys.float_info.max.

source/blender/makesrna/intern/rna_rna.c
source/blender/python/intern/bpy_props.c

index 9834520f952bd4cbe5773e5799d0aecc7bc8bd2c..3ca4792f9b4b1aff359c775aca68b2746f8f0c12 100644 (file)
@@ -3077,7 +3077,7 @@ void RNA_def_rna(BlenderRNA *brna)
   /* FloatProperty */
   srna = RNA_def_struct(brna, "FloatProperty", "Property");
   RNA_def_struct_ui_text(
-      srna, "Float Definition", "RNA floating pointer number property definition");
+      srna, "Float Definition", "RNA floating point number (single precision) property definition");
   rna_def_number_property(srna, PROP_FLOAT);
 
   /* StringProperty */
index ad7d5137ebc7e35d64108f7656f77fc410ab0a3d..b49417872db5df7eb430b28253b7c364c6e73c9c 100644 (file)
@@ -2566,8 +2566,8 @@ PyDoc_STRVAR(BPy_FloatProperty_doc,
              ".. function:: FloatProperty(name=\"\", "
              "description=\"\", "
              "default=0.0, "
-             "min=sys.float_info.min, max=sys.float_info.max, "
-             "soft_min=sys.float_info.min, soft_max=sys.float_info.max, "
+             "min=-3.402823e+38, max=3.402823e+38, "
+             "soft_min=-3.402823e+38, soft_max=3.402823e+38, "
              "step=3, "
              "precision=2, "
              "options={'ANIMATABLE'}, "
@@ -2578,7 +2578,7 @@ PyDoc_STRVAR(BPy_FloatProperty_doc,
              "get=None, "
              "set=None)\n"
              "\n"
-             "   Returns a new float property definition.\n"
+             "   Returns a new float (single precision) property definition.\n"
              "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_NUM_MIN_DOC
              "   :type min: float\n" BPY_PROPDEF_NUM_MAX_DOC
              "   :type max: float\n" BPY_PROPDEF_NUM_SOFTMIN_DOC