Add some missing docstring params
This commit is contained in:
parent
26d308d95d
commit
bbb44f6e50
|
|
@ -779,6 +779,7 @@ class AbstractAudio(QObject):
|
|||
"""Set this tab as muted or not.
|
||||
|
||||
Arguments:
|
||||
muted: Whether the tab is currently muted.
|
||||
override: If set to True, muting/unmuting was done manually and
|
||||
overrides future automatic mute/unmute changes based on
|
||||
the URL.
|
||||
|
|
|
|||
|
|
@ -1521,6 +1521,7 @@ class CommandDispatcher:
|
|||
Callback for GUIProcess when the edited text was updated.
|
||||
|
||||
Args:
|
||||
ed: The editor.ExternalEditor instance
|
||||
elem: The WebElementWrapper which was modified.
|
||||
text: The new text to insert.
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -324,6 +324,7 @@ class GreasemonkeyManager(QObject):
|
|||
"""Add a GreasemonkeyScript to this manager.
|
||||
|
||||
Args:
|
||||
script: The GreasemonkeyScript to add.
|
||||
force: Fetch and overwrite any dependencies which are
|
||||
already locally cached.
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -405,6 +405,7 @@ class WebHistory(sql.SqlTable):
|
|||
|
||||
Args:
|
||||
url: A url (as QUrl) to add to the history.
|
||||
title: The tab title to add.
|
||||
redirect: Whether the entry was redirected to another URL
|
||||
(hidden in completion)
|
||||
atime: Override the atime used to add the entry
|
||||
|
|
|
|||
|
|
@ -503,6 +503,7 @@ class DownloadManager(downloads.AbstractDownloadManager):
|
|||
Args:
|
||||
request: The QNetworkRequest to download.
|
||||
target: Where to save the download as downloads.DownloadTarget.
|
||||
suggested_fn: The filename to use for the file.
|
||||
**kwargs: Passed to _fetch_request.
|
||||
|
||||
Return:
|
||||
|
|
@ -547,6 +548,9 @@ class DownloadManager(downloads.AbstractDownloadManager):
|
|||
target: Where to save the download as downloads.DownloadTarget.
|
||||
auto_remove: Whether to remove the download even if
|
||||
downloads.remove_finished is set to -1.
|
||||
suggested_filename: The filename to use for the file.
|
||||
prompt_download_directory: Whether to prompt for a location to
|
||||
download the file to.
|
||||
|
||||
Return:
|
||||
The created DownloadItem.
|
||||
|
|
|
|||
|
|
@ -132,6 +132,7 @@ class AbstractWebElement(collections.abc.MutableMapping): # type: ignore[type-a
|
|||
"""Dispatch an event to the element.
|
||||
|
||||
Args:
|
||||
event: The name of the event.
|
||||
bubbles: Whether this event should bubble.
|
||||
cancelable: Whether this event can be cancelled.
|
||||
composed: Whether the event will trigger listeners outside of a
|
||||
|
|
|
|||
|
|
@ -70,6 +70,7 @@ class CompletionModel(QAbstractItemModel):
|
|||
|
||||
Args:
|
||||
index: The QModelIndex to get item flags for.
|
||||
role: The Qt ItemRole to get the data for.
|
||||
|
||||
Return: The item data, or None on an invalid index.
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -137,6 +137,7 @@ def bind(key, *, info):
|
|||
|
||||
Args:
|
||||
key: the key being bound.
|
||||
info: A CompletionInfo instance.
|
||||
"""
|
||||
model = completionmodel.CompletionModel(column_widths=(20, 60, 20))
|
||||
data = _bind_current_default(key, info)
|
||||
|
|
|
|||
|
|
@ -387,6 +387,8 @@ class Config(QObject):
|
|||
"""Get the given setting converted for Python code.
|
||||
|
||||
Args:
|
||||
name: The name of the setting to get.
|
||||
url: The URL to get the value for.
|
||||
fallback: Use the global value if there's no URL-specific one.
|
||||
"""
|
||||
opt = self.get_opt(name)
|
||||
|
|
|
|||
|
|
@ -87,6 +87,7 @@ class KeyHintView(QLabel):
|
|||
"""Show hints for the given prefix (or hide if prefix is empty).
|
||||
|
||||
Args:
|
||||
mode: The key mode to show the keyhints for.
|
||||
prefix: The current partial keystring.
|
||||
"""
|
||||
match = re.fullmatch(r'(\d*)(.*)', prefix)
|
||||
|
|
|
|||
|
|
@ -42,6 +42,7 @@ def msgbox(parent, title, text, *, icon, buttons=QMessageBox.Ok,
|
|||
parent: The parent to set for the message box.
|
||||
title: The title to set.
|
||||
text: The text to set.
|
||||
icon: The QIcon to show in the box.
|
||||
buttons: The buttons to set (QMessageBox::StandardButtons)
|
||||
on_finished: A slot to connect to the 'finished' signal.
|
||||
plain_text: Whether to force plain text (True) or rich text (False).
|
||||
|
|
|
|||
|
|
@ -157,6 +157,7 @@ class SaveManager(QObject):
|
|||
"""Save a saveable by name.
|
||||
|
||||
Args:
|
||||
name: The name of the saveable to save.
|
||||
is_exit: Whether we're currently exiting qutebrowser.
|
||||
explicit: Whether this save operation was triggered explicitly.
|
||||
silent: Don't write information to log. Used to reduce log spam
|
||||
|
|
|
|||
|
|
@ -128,6 +128,7 @@ def split(s, keep=False):
|
|||
"""Split a string via ShellLexer.
|
||||
|
||||
Args:
|
||||
s: The string to split.
|
||||
keep: Whether to keep special chars in the split output.
|
||||
"""
|
||||
lexer = ShellLexer(s)
|
||||
|
|
|
|||
|
|
@ -381,8 +381,8 @@ def qt_message_handler(msg_type: QtCore.QtMsgType,
|
|||
"""Qt message handler to redirect qWarning etc. to the logging system.
|
||||
|
||||
Args:
|
||||
QtMsgType msg_type: The level of the message.
|
||||
QMessageLogContext context: The source code location of the message.
|
||||
msg_type: The level of the message.
|
||||
context: The source code location of the message.
|
||||
msg: The message text.
|
||||
"""
|
||||
# Mapping from Qt logging levels to the matching logging module levels.
|
||||
|
|
|
|||
|
|
@ -140,7 +140,7 @@ def ask_async(title: str,
|
|||
"""Ask an async question in the statusbar.
|
||||
|
||||
Args:
|
||||
message: The message to display to the user.
|
||||
title: The message to display to the user.
|
||||
mode: A PromptMode.
|
||||
handler: The function to get called with the answer as argument.
|
||||
default: The default value to display.
|
||||
|
|
|
|||
|
|
@ -329,6 +329,7 @@ def invalid_url_error(url: QUrl, action: str) -> None:
|
|||
"""Display an error message for a URL.
|
||||
|
||||
Args:
|
||||
url: The URL to display a message for.
|
||||
action: The action which was interrupted by the error.
|
||||
"""
|
||||
if url.isValid():
|
||||
|
|
|
|||
|
|
@ -550,6 +550,7 @@ def github_upload(artifacts, tag, gh_token):
|
|||
Args:
|
||||
artifacts: A list of (filename, mimetype, description) tuples
|
||||
tag: The name of the release tag
|
||||
gh_token: The GitHub token to use
|
||||
"""
|
||||
import github3
|
||||
import github3.exceptions
|
||||
|
|
|
|||
Loading…
Reference in New Issue