Improve :history-clear docstring

This commit is contained in:
Florian Bruhin 2016-06-08 16:49:07 +02:00
parent 483a5f8103
commit 263b5680c7
2 changed files with 10 additions and 3 deletions

View File

@ -26,7 +26,7 @@
|<<fullscreen,fullscreen>>|Toggle fullscreen mode.
|<<help,help>>|Show help about a command or setting.
|<<hint,hint>>|Start hinting.
|<<history-clear,history-clear>>|Clear all history entries.
|<<history-clear,history-clear>>|Clear all browsing history.
|<<home,home>>|Open main startpage in current tab.
|<<inspector,inspector>>|Toggle the web inspector.
|<<jseval,jseval>>|Evaluate a JavaScript string.
@ -359,7 +359,9 @@ Start hinting.
[[history-clear]]
=== history-clear
Clear all history entries.
Clear all browsing history.
Note this only clears the global history (e.g. `~/.local/share/qutebrowser/history` on Linux) but not cookies, the back/forward history of a tab, cache or other persistent data.
[[home]]
=== home

View File

@ -179,7 +179,12 @@ class WebHistory(QWebHistoryInterface):
@cmdutils.register(name='history-clear', instance='web-history')
def clear(self):
"""Clear all history entries."""
"""Clear all browsing history.
Note this only clears the global history
(e.g. `~/.local/share/qutebrowser/history` on Linux) but not cookies,
the back/forward history of a tab, cache or other persistent data.
"""
self._lineparser.clear()
self._history_dict.clear()
self._temp_history.clear()