Fixed docs.
This commit is contained in:
parent
55193803a1
commit
6e3d5867f9
@ -131,11 +131,11 @@ Contributors, sorted by the number of commits in descending order:
|
|||||||
* Florian Bruhin
|
* Florian Bruhin
|
||||||
* Claude
|
* Claude
|
||||||
* ZDarian
|
* ZDarian
|
||||||
|
* Joel Torstensson
|
||||||
* Peter Vilim
|
* Peter Vilim
|
||||||
* John ShaggyTwoDope Jenkins
|
* John ShaggyTwoDope Jenkins
|
||||||
* rikn00
|
* rikn00
|
||||||
* Martin Zimmermann
|
* Martin Zimmermann
|
||||||
* Joel Torstensson
|
|
||||||
* Error 800
|
* Error 800
|
||||||
* Brian Jackson
|
* Brian Jackson
|
||||||
* Patric Schmitz
|
* Patric Schmitz
|
||||||
|
@ -8,10 +8,11 @@
|
|||||||
|<<adblock-update,adblock-update>>|Update the adblock block lists.
|
|<<adblock-update,adblock-update>>|Update the adblock block lists.
|
||||||
|<<back,back>>|Go back in the history of the current tab.
|
|<<back,back>>|Go back in the history of the current tab.
|
||||||
|<<bind,bind>>|Bind a key to a command.
|
|<<bind,bind>>|Bind a key to a command.
|
||||||
|<<cancel-download,cancel-download>>|Cancel the first/[count]th download.
|
|
||||||
|<<close,close>>|Close the current window.
|
|<<close,close>>|Close the current window.
|
||||||
|<<download,download>>|Download a given URL, given as string.
|
|<<download,download>>|Download a given URL, or current page if no URL given.
|
||||||
|<<download-page,download-page>>|Download the current page.
|
|<<download-cancel,download-cancel>>|Cancel the last/[count]th download.
|
||||||
|
|<<download-open,download-open>>|Open the last/[count]th finished download.
|
||||||
|
|<<download-remove,download-remove>>|Remove the last/[count]th finished download.
|
||||||
|<<forward,forward>>|Go forward in the history of the current tab.
|
|<<forward,forward>>|Go forward in the history of the current tab.
|
||||||
|<<fullscreen,fullscreen>>|Toggle fullscreen mode.
|
|<<fullscreen,fullscreen>>|Toggle fullscreen mode.
|
||||||
|<<help,help>>|Show help about a command or setting.
|
|<<help,help>>|Show help about a command or setting.
|
||||||
@ -85,30 +86,45 @@ Bind a key to a command.
|
|||||||
* +*-m*+, +*--mode*+: A comma-separated list of modes to bind the key in (default: `normal`).
|
* +*-m*+, +*--mode*+: A comma-separated list of modes to bind the key in (default: `normal`).
|
||||||
|
|
||||||
|
|
||||||
[[cancel-download]]
|
|
||||||
=== cancel-download
|
|
||||||
Cancel the first/[count]th download.
|
|
||||||
|
|
||||||
==== count
|
|
||||||
The index of the download to cancel.
|
|
||||||
|
|
||||||
[[close]]
|
[[close]]
|
||||||
=== close
|
=== close
|
||||||
Close the current window.
|
Close the current window.
|
||||||
|
|
||||||
[[download]]
|
[[download]]
|
||||||
=== download
|
=== download
|
||||||
Syntax: +:download 'url' ['dest']+
|
Syntax: +:download ['url'] ['dest']+
|
||||||
|
|
||||||
Download a given URL, given as string.
|
Download a given URL, or current page if no URL given.
|
||||||
|
|
||||||
==== positional arguments
|
==== positional arguments
|
||||||
* +'url'+: The URL to download
|
* +'url'+: The URL to download. If not given, download the current page.
|
||||||
* +'dest'+: The file path to write the download to to ask.
|
* +'dest'+: The file path to write the download to to ask.
|
||||||
|
|
||||||
[[download-page]]
|
[[download-cancel]]
|
||||||
=== download-page
|
=== download-cancel
|
||||||
Download the current page.
|
Cancel the last/[count]th download.
|
||||||
|
|
||||||
|
==== count
|
||||||
|
The index of the download to cancel.
|
||||||
|
|
||||||
|
[[download-open]]
|
||||||
|
=== download-open
|
||||||
|
Open the last/[count]th finished download.
|
||||||
|
|
||||||
|
==== count
|
||||||
|
The index of the download to cancel.
|
||||||
|
|
||||||
|
[[download-remove]]
|
||||||
|
=== download-remove
|
||||||
|
Syntax: +:download-remove [*--all*]+
|
||||||
|
|
||||||
|
Remove the last/[count]th finished download.
|
||||||
|
|
||||||
|
==== optional arguments
|
||||||
|
* +*-a*+, +*--all*+: If given removes all finished downloads.
|
||||||
|
|
||||||
|
==== count
|
||||||
|
The index of the download to cancel.
|
||||||
|
|
||||||
[[forward]]
|
[[forward]]
|
||||||
=== forward
|
=== forward
|
||||||
|
@ -915,7 +915,7 @@ class CommandDispatcher:
|
|||||||
"""Download a given URL, or current page if no URL given.
|
"""Download a given URL, or current page if no URL given.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
url: The URL to download, or None to download current page.
|
url: The URL to download. If not given, download the current page.
|
||||||
dest: The file path to write the download to, or None to ask.
|
dest: The file path to write the download to, or None to ask.
|
||||||
"""
|
"""
|
||||||
download_manager = objreg.get('download-manager', scope='window',
|
download_manager = objreg.get('download-manager', scope='window',
|
||||||
|
@ -833,7 +833,7 @@ class DownloadManager(QAbstractListModel):
|
|||||||
"""Remove the last/[count]th finished download.
|
"""Remove the last/[count]th finished download.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
all: Whether to remove all finished downloads.
|
all_: If given removes all finished downloads.
|
||||||
count: The index of the download to cancel.
|
count: The index of the download to cancel.
|
||||||
"""
|
"""
|
||||||
finished_items = [d for d in self.downloads if d.done]
|
finished_items = [d for d in self.downloads if d.done]
|
||||||
|
Loading…
Reference in New Issue
Block a user