Merge branch 'lahwaacz-docstrings'

This commit is contained in:
Florian Bruhin 2016-09-05 10:58:50 +02:00
commit 63090df52b
6 changed files with 10 additions and 19 deletions

View File

@ -9,13 +9,15 @@ In qutebrowser, all keybindings are mapped to commands.
Some commands are hidden, which means they don't show up in the command Some commands are hidden, which means they don't show up in the command
completion when pressing `:`, as they're typically not useful to run by hand. completion when pressing `:`, as they're typically not useful to run by hand.
In the commandline, there are also some variables you can use: For command arguments, there are also some variables you can use:
- `{url}` expands to the URL of the current page - `{url}` expands to the URL of the current page
- `{url:pretty}` expands to the URL in decoded format - `{url:pretty}` expands to the URL in decoded format
- `{clipboard}` expands to the clipboard contents - `{clipboard}` expands to the clipboard contents
- `{primary}` expands to the primary selection contents - `{primary}` expands to the primary selection contents
It is possible to run or bind multiple commands by separating them with `;;`.
== Normal commands == Normal commands
.Quick reference .Quick reference
[options="header",width="75%",cols="25%,75%"] [options="header",width="75%",cols="25%,75%"]
@ -92,7 +94,7 @@ In the commandline, there are also some variables you can use:
=== adblock-update === adblock-update
Update the adblock block lists. Update the adblock block lists.
This updates ~/.local/share/qutebrowser/blocked-hosts with downloaded host lists and re-reads ~/.config/qutebrowser/blocked-hosts. This updates `~/.local/share/qutebrowser/blocked-hosts` with downloaded host lists and re-reads `~/.config/qutebrowser/blocked-hosts`.
[[back]] [[back]]
=== back === back
@ -724,8 +726,6 @@ Syntax: +:set-cmd-text [*--space*] [*--append*] 'text'+
Preset the statusbar to some text. Preset the statusbar to some text.
You can use the `{url}` and `{url:pretty}` variables here which will get replaced by the encoded/decoded URL.
==== positional arguments ==== positional arguments
* +'text'+: The commandline to set. * +'text'+: The commandline to set.
@ -742,8 +742,6 @@ Syntax: +:spawn [*--userscript*] [*--verbose*] [*--detach*] 'cmdline'+
Spawn a command in a shell. Spawn a command in a shell.
Note the `{url}` and `{url:pretty}` variables might be useful here. `{url}` gets replaced by the URL in fully encoded format and `{url:pretty}` uses a "pretty form" with most percent-encoded characters decoded.
==== positional arguments ==== positional arguments
* +'cmdline'+: The commandline to execute. * +'cmdline'+: The commandline to execute.

View File

@ -182,8 +182,8 @@ class HostBlocker:
def adblock_update(self, win_id): def adblock_update(self, win_id):
"""Update the adblock block lists. """Update the adblock block lists.
This updates ~/.local/share/qutebrowser/blocked-hosts with downloaded This updates `~/.local/share/qutebrowser/blocked-hosts` with downloaded
host lists and re-reads ~/.config/qutebrowser/blocked-hosts. host lists and re-reads `~/.config/qutebrowser/blocked-hosts`.
""" """
self._read_hosts_file(self._config_hosts_file, self._read_hosts_file(self._config_hosts_file,
self._config_blocked_hosts) self._config_blocked_hosts)

View File

@ -1027,11 +1027,6 @@ class CommandDispatcher:
def spawn(self, cmdline, userscript=False, verbose=False, detach=False): def spawn(self, cmdline, userscript=False, verbose=False, detach=False):
"""Spawn a command in a shell. """Spawn a command in a shell.
Note the `{url}` and `{url:pretty}` variables might be useful here.
`{url}` gets replaced by the URL in fully encoded format and
`{url:pretty}` uses a "pretty form" with most percent-encoded
characters decoded.
Args: Args:
userscript: Run the command as a userscript. You can use an userscript: Run the command as a userscript. You can use an
absolute path, or store the userscript in one of those absolute path, or store the userscript in one of those

View File

@ -22,10 +22,12 @@
Some commands are hidden, which means they don't show up in the command Some commands are hidden, which means they don't show up in the command
completion when pressing `:`, as they're typically not useful to run by hand. completion when pressing `:`, as they're typically not useful to run by hand.
In the commandline, there are also some variables you can use: For command arguments, there are also some variables you can use:
- `{url}` expands to the URL of the current page - `{url}` expands to the URL of the current page
- `{url:pretty}` expands to the URL in decoded format - `{url:pretty}` expands to the URL in decoded format
- `{clipboard}` expands to the clipboard contents - `{clipboard}` expands to the clipboard contents
- `{primary}` expands to the primary selection contents - `{primary}` expands to the primary selection contents
It is possible to run or bind multiple commands by separating them with `;;`.
""" """

View File

@ -1401,8 +1401,7 @@ KEY_FIRST_COMMENT = """
# #
# For simple keys (no `<>`-signs), a capital letter means the key is pressed # For simple keys (no `<>`-signs), a capital letter means the key is pressed
# with Shift. For special keys (with `<>`-signs), you need to explicitly add # with Shift. For special keys (with `<>`-signs), you need to explicitly add
# `Shift-` to match a key pressed with shift. You can bind multiple commands # `Shift-` to match a key pressed with shift.
# by separating them with `;;`.
# #
# Note that default keybindings are always bound, and need to be explicitly # Note that default keybindings are always bound, and need to be explicitly
# unbound if you wish to remove them: # unbound if you wish to remove them:

View File

@ -95,9 +95,6 @@ class Command(misc.MinimalLineEditMixin, misc.CommandLineEdit):
def set_cmd_text_command(self, text, space=False, append=False): def set_cmd_text_command(self, text, space=False, append=False):
"""Preset the statusbar to some text. """Preset the statusbar to some text.
You can use the `{url}` and `{url:pretty}` variables here which will
get replaced by the encoded/decoded URL.
// //
Wrapper for set_cmd_text to check the arguments and allow multiple Wrapper for set_cmd_text to check the arguments and allow multiple