ProgressDialog docstrign tweak

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

diff --git a/wxPython/src/_cmndlgs.i b/wxPython/src/_cmndlgs.i
index 242ea66e70d79ff5ae0c83698a82f24631e7024a..1e4c13c7deb0ce773e9b3a3c49b444be0cbccd8d 100644 (file)
--- a/wxPython/src/_cmndlgs.i
+++ b/wxPython/src/_cmndlgs.i
@@ -660,8 +660,10 @@ parent window only.", "");
     DocDeclStr(
         virtual bool , Update(int value, const wxString& newmsg = wxPyEmptyString),
         "Updates the dialog, setting the progress bar to the new value and, if
-given changes the message above it. Returns true unless the Cancel
-button has been pressed.
+given changes the message above it. The value given should be less
+than or equal to the maximum value given to the constructor and the
+dialog is closed if it is equal to the maximum.  Returns true unless
+the Cancel button has been pressed.
 
 If false is returned, the application can either immediately destroy
 the dialog or ask the user for the confirmation and if the abort is