Fix docs for :click-element

This commit is contained in:
Florian Bruhin 2016-08-18 16:53:28 +02:00
parent 927f378c6d
commit 205c12c530
2 changed files with 20 additions and 2 deletions

View File

@ -944,6 +944,7 @@ How many steps to zoom out.
|==============
|Command|Description
|<<clear-keychain,clear-keychain>>|Clear the currently entered key chain.
|<<click-element,click-element>>|Click the element matching the given filter.
|<<command-accept,command-accept>>|Execute the command currently in the commandline.
|<<command-history-next,command-history-next>>|Go forward in the commandline history.
|<<command-history-prev,command-history-prev>>|Go back in the commandline history.
@ -1007,6 +1008,22 @@ How many steps to zoom out.
=== clear-keychain
Clear the currently entered key chain.
[[click-element]]
=== click-element
Syntax: +:click-element [*--target* 'target'] 'filter' 'value'+
Click the element matching the given filter.
The given filter needs to result in exactly one element, otherwise, an error is shown.
==== positional arguments
* +'filter'+: How to filter the elements. id: Get an element based on its ID.
* +'value'+: The value to filter for.
==== optional arguments
* +*-t*+, +*--target*+: How to open the clicked element (normal/tab/tab-bg/window).
[[command-accept]]
=== command-accept
Execute the command currently in the commandline.

View File

@ -1540,9 +1540,10 @@ class CommandDispatcher:
error is shown.
Args:
filter: How to filter the elements.
id: Get an element based on its ID.
filter_: How to filter the elements.
id: Get an element based on its ID.
value: The value to filter for.
target: How to open the clicked element (normal/tab/tab-bg/window).
"""
tab = self._current_widget()