Typing errors in documentation file

Bug reports.
tkondal
Posts: 24
Joined: Fri Nov 03, 2006 5:50 pm

Typing errors in documentation file

Post by tkondal » Fri Jan 26, 2007 7:28 pm

Here's a typing error that I found in the documentation when looking at the doc for "ControlSendKeys":

"To send keyboard characters that are comprised of a regular keystroke in combination with a SHIFT, CTRL, or ALT, crete a compound "

"crete" should be "create".


Note: Maybe this thread should be used to post all documentation bugs so that they are consolidated.

tkondal
Posts: 24
Joined: Fri Nov 03, 2006 5:50 pm

Post by tkondal » Fri Jan 26, 2007 7:29 pm

I also noted that the documenation for "ControlSendKeys" refers to the "SendKeys" method instead of "ControlSendKeys".

admin
Site Admin
Site Admin
Posts: 350
Joined: Wed Jul 05, 2006 7:44 pm

Post by admin » Sun Jan 28, 2007 11:13 pm

Thank you for this info, we have corrected the documentation for the next release.

Jenö

tkondal
Posts: 24
Joined: Fri Nov 03, 2006 5:50 pm

Post by tkondal » Fri Feb 02, 2007 7:02 pm

Here's another one in the ButtonCheck() and ButtonUncheck() docs:

If the button could be ckecked the return value is True, otherwise False.

and...

If the button could be unckecked the return value is True, otherwise False.

admin
Site Admin
Site Admin
Posts: 350
Joined: Wed Jul 05, 2006 7:44 pm

Post by admin » Sun Feb 04, 2007 10:30 pm

Thank you for the info.
We have corrected the text for V1.1.0

Jenö

tkondal
Posts: 24
Joined: Fri Nov 03, 2006 5:50 pm

Post by tkondal » Tue Feb 06, 2007 4:54 pm

Another one that caused me to spend a day on my script...

MouseClickElement():

"If the function succeeds, the return value is zero, otherwise the return value is an error code. "

In my case, when the function succeeds, it returns 1, and when it fails, it returns 0.

I have noted that there are many inconsistencies in the return codes for various functions. Just a suggestion for the next version, it would be easier for developers to compare the return code to a pre-defined constant.

Here's a Python code to show what I mean:

rc = Ranorex.MouseClickElement(eMyElement)
if (rc == Ranorex.RC_OK):
print "Success"
else:
print "Fail"

admin
Site Admin
Site Admin
Posts: 350
Joined: Wed Jul 05, 2006 7:44 pm

Post by admin » Tue Feb 06, 2007 11:23 pm

Thank you for this important info, we checked the call chain of the mouse functions and found a bug. It can happen, that the functions MouseMoveToElement and MouseClickElement return a false value.

We corrected the bug for the next version V1.1.0.
tkondal wrote:Just a suggestion for the next version, it would be easier for developers to compare the return code to a pre-defined constant.
Good idea, but unfortunately we cannot support this in the next release.
We have a lot of user and we want to be compatible with earlier versions.

Jenö

tkondal
Posts: 24
Joined: Fri Nov 03, 2006 5:50 pm

Ranorex 1.1 Doc Typo

Post by tkondal » Mon Mar 26, 2007 7:21 pm

I noticed in the documentation for 1.1 that there is a "File List" item with "RanorexPython.cpp" in it; is this supposed to be there?

Also, the entry for "Menu Functions" has a ".n" appended to it.

tkondal
Posts: 24
Joined: Fri Nov 03, 2006 5:50 pm

TreeViewGetSelectedItem

Post by tkondal » Mon Mar 26, 2007 8:16 pm

In the doc for Ranorex.TreeViewGetSelectedItem, it says:
The handle of the next item if successful,...

I'm guessing this should be :
The handle of the selected item if successful,...

admin
Site Admin
Site Admin
Posts: 350
Joined: Wed Jul 05, 2006 7:44 pm

Post by admin » Tue Mar 27, 2007 8:09 pm

Thanks for this info...
In the doc for Ranorex.TreeViewGetSelectedItem, it says:
The handle of the next item if successful,...

I'm guessing this should be :
The handle of the selected item if successful,...
You can find the corrected docu in the next release...
I noticed in the documentation for 1.1 that there is a "File List" item with "RanorexPython.cpp" in it; is this supposed to be there?
The whole documentation will be generated automatically. This file will be appended.
Also, the entry for "Menu Functions" has a ".n" appended to it.
This is a type error, we will fix it for the next release.

Gabor
Ranorex Team

tkondal
Posts: 24
Joined: Fri Nov 03, 2006 5:50 pm

RanorexPython.ApplicationGetFirst

Post by tkondal » Fri Mar 30, 2007 4:23 pm

RanorexPython.ApplicationGetFirst

The documentation is misleading, the return type should be handle if successful, and 0 if not.

admin
Site Admin
Site Admin
Posts: 350
Joined: Wed Jul 05, 2006 7:44 pm

Post by admin » Sun Apr 01, 2007 9:29 pm

Thank you for this info, we have corrected the documentation for the next release.

Please read also the post:

http://www.ranorex.com/forum/applicatio ... -t147.html

Jenö
Ranorex Team