Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarifying the documentation #66

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarifying the documentation #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/ImageHorizonLibrary/interaction/_operating_system.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,11 @@ def launch_application(self, app, alias=None):
On Windows, if you are using relative or absolute paths in ``app``,
enclose the command with double quotes:

| Launch Application | "C:\\my folder\\myprogram.exe" | # Needs quotes |
| Launch Application | myprogram.exe | # No need for quotes |
| Launch Application | "C:\\my folder\\myprogram.exe" | # Needs quotes ||||
| Launch Application | myprogram.exe | # No need for quotes ||||
| Launch Application | myprogram.exe | arg1 | arg2 | # Program with arguments ||
| Launch Application | myprogram.exe | alias=myprog | # Program with alias |||
| Launch Application | myprogram.exe | arg1 | arg2 | alias=myprog | # Program with arguments and alias |

Returns automatically generated alias which can be used with `Terminate
Application`.
Expand Down
6 changes: 3 additions & 3 deletions src/ImageHorizonLibrary/recognition/_recognize_images.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def __normalize(self, path):
return path

def click_image(self, reference_image):
'''Finds the reference image on screen and clicks it once.
'''Finds the reference image on screen and clicks at the centre point once.

``reference_image`` is automatically normalized as described in the
`Reference image names`.
Expand Down Expand Up @@ -225,7 +225,7 @@ def locate(self, reference_image):

Fails if image is not found on screen.

Returns Python tuple ``(x, y)`` of the coordinates.
Returns Python tuple ``(x, y)`` of the coordinates matching the center point of the reference image.
'''
return self._locate(reference_image)

Expand All @@ -239,7 +239,7 @@ def wait_for(self, reference_image, timeout=10):

``timeout`` is given in seconds.

Returns Python tuple ``(x, y)`` of the coordinates.
Returns Python tuple ``(x, y)`` of the coordinates matching the center point of the reference image.
'''
stop_time = time() + int(timeout)
location = None
Expand Down