testapi: Improve documentation for "wait_screen_change"

Motivated by os-autoinst/os-autoinst-distri-opensuse#4823 (comment)
okurz · Apr 12, 2018 · 3af2963 · 3af2963
1 parent 3ca7dc3
commit 3af2963
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/testapi.pm b/testapi.pm
@@ -459,9 +459,11 @@ sub assert_and_dclick {
 
   wait_screen_change(CODEREF [,$timeout [, similarity_level => 50]]);
 
-Wrapper around code that is supposed to change the screen.
-This is the opposite to C<wait_still_screen>. Make sure to put the commands to change the screen
-within the block to avoid races between the action and the screen change.
+Wrapper around code that is supposed to change the screen. This is the
+opposite to C<wait_still_screen>. Make sure to put the commands to change the
+screen within the block to avoid races between the action and the screen
+change. C<wait_screen_change> waits for a screen change after C<CODEREF> was
+executed.
 
 Example: