Minor Text Fixes

default (program) -> default application
surround {} with backticks
mention that the filename will be appended in the docstrings
This commit is contained in:
Daniel Schadt 2016-08-04 11:54:27 +02:00
parent 017bfc9b9c
commit d21b42662d
3 changed files with 14 additions and 8 deletions

View File

@ -534,8 +534,10 @@ class DownloadItem(QObject):
"""Open the downloaded file.
Args:
cmdline: The command to use, or None for the system's default
program.
cmdline: The command to use as string. A `{}` is expanded to the
filename. None means to use the system's default
application. If no `{}` is found, the filename is appended
to the cmdline.
"""
assert self.successful
filename = self._filename
@ -988,8 +990,7 @@ class DownloadManager(QAbstractListModel):
Args:
download: The DownloadItem to use.
cmdline: The command to use, or None for the system's default
program.
cmdline: Passed to DownloadItem.open_file().
"""
if not download.successful:
log.downloads.debug("{} finished but not successful, not opening!"
@ -1064,7 +1065,9 @@ class DownloadManager(QAbstractListModel):
Args:
cmdline: The command which should be used to open the file. A `{}`
is expanded to the temporary file name.
is expanded to the temporary file name. If no `{}` is
present, the filename is automatically appended to the
cmdline.
count: The index of the download to open.
"""
try:

View File

@ -321,7 +321,9 @@ class Prompter(QObject):
Args:
cmdline: The command which should be used to open the file. A `{}`
is expanded to the temporary file name.
is expanded to the temporary file name. If no `{}` is
present, the filename is automatically appended to the
cmdline.
"""
if self._question.mode != usertypes.PromptMode.download:
# We just ignore this if we don't have a download question.

View File

@ -300,8 +300,9 @@ class OpenFileDownloadTarget(DownloadTarget):
"""Save the download in a temp dir and directly open it.
Attributes:
cmdline: The command to use as string. A {} is expanded to the
filename. None means use the system's default.
cmdline: The command to use as string. A `{}` is expanded to the
filename. None means to use the system's default application.
If no `{}` is found, the filename is appended to the cmdline.
"""
def __init__(self, cmdline=None):