summaryrefslogtreecommitdiff
path: root/qutebrowser/qt/webkit.py
diff options
context:
space:
mode:
Diffstat (limited to 'qutebrowser/qt/webkit.py')
-rw-r--r--qutebrowser/qt/webkit.py18
1 files changed, 14 insertions, 4 deletions
diff --git a/qutebrowser/qt/webkit.py b/qutebrowser/qt/webkit.py
index b4b983037..c8b5c0b39 100644
--- a/qutebrowser/qt/webkit.py
+++ b/qutebrowser/qt/webkit.py
@@ -1,14 +1,24 @@
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
-# FIXME:qt6 (lint)
-# pylint: disable=missing-module-docstring,wildcard-import,no-else-raise
-# flake8: noqa
+# pylint: disable=wildcard-import
+
+"""Wrapped Qt imports for Qt WebKit.
+
+All code in qutebrowser should use this module instead of importing from
+PyQt/PySide directly. This allows supporting both Qt 5 and Qt 6
+(though WebKit is only supported with Qt 5).
+
+See machinery.py for details on how Qt wrapper selection works.
+
+Any API exported from this module is based on the QtWebKit 5.212 API:
+https://qtwebkit.github.io/doc/qtwebkit/qtwebkit-index.html
+"""
from qutebrowser.qt import machinery
machinery.init()
-if machinery.USE_PYSIDE6:
+if machinery.USE_PYSIDE6: # pylint: disable=no-else-raise
raise machinery.Unavailable()
elif machinery.USE_PYQT5:
from PyQt5.QtWebKit import *