Document how the sign is omitted from wxFloatProperty's displayed value when it is...

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@66384 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/propgrid/property.h b/interface/wx/propgrid/property.h
index e2bbb158ec33710188ef7b0e006f643a9d2a57e6..f67b50e0dabd778367c61491188ae4360592b3f8 100644 (file)
--- a/interface/wx/propgrid/property.h
+++ b/interface/wx/propgrid/property.h
@@ -409,6 +409,12 @@ wxPG_PROP_BEING_DELETED             = 0x00200000
     Default float-to-text precision is 6 decimals, but this can be changed
     by modifying wxPG_FLOAT_PRECISION attribute.
 
     Default float-to-text precision is 6 decimals, but this can be changed
     by modifying wxPG_FLOAT_PRECISION attribute.
 

+    Note that when displaying the value, sign is omitted if the resulting
+    textual representation is effectively zero (for example, -0.0001 with
+    precision of 3 will become 0.0 instead of -0.0). This behavior is unlike 
+    what C standard library does, but should result in better end-user
+    experience in almost all cases.
+

     @subsection wxBoolProperty
 
     Represents a boolean value. wxChoice is used as editor control, by the
     @subsection wxBoolProperty
 
     Represents a boolean value. wxChoice is used as editor control, by the