Improve documentation for :hint --rapid

This commit is contained in:
Florian Bruhin 2017-11-10 10:23:16 +01:00
parent d19d896881
commit 456c854f06
2 changed files with 9 additions and 5 deletions

View File

@ -493,8 +493,10 @@ Start hinting.
==== optional arguments
* +*-r*+, +*--rapid*+: Whether to do rapid hinting. This is only possible with targets `tab` (with `tabs.background_tabs=true`), `tab-bg`,
`window`, `run`, `hover`, `userscript` and `spawn`.
* +*-r*+, +*--rapid*+: Whether to do rapid hinting. With rapid hinting, the hint mode isn't left after a hint is followed, so you can easily open
multiple links. This is only possible with targets `tab`
(with `tabs.background_tabs=true`), `tab-bg`, `window`,
`run`, `hover`, `userscript` and `spawn`.
* +*-m*+, +*--mode*+: The hinting mode to use.

View File

@ -617,9 +617,11 @@ class HintManager(QObject):
"""Start hinting.
Args:
rapid: Whether to do rapid hinting. This is only possible with
targets `tab` (with `tabs.background_tabs=true`), `tab-bg`,
`window`, `run`, `hover`, `userscript` and `spawn`.
rapid: Whether to do rapid hinting. With rapid hinting, the hint
mode isn't left after a hint is followed, so you can easily open
multiple links. This is only possible with targets `tab`
(with `tabs.background_tabs=true`), `tab-bg`, `window`,
`run`, `hover`, `userscript` and `spawn`.
add_history: Whether to add the spawned or yanked link to the
browsing history.
group: The element types to hint.