diff options
author | Florian Bruhin <me@the-compiler.org> | 2023-06-12 21:40:27 +0200 |
---|---|---|
committer | Florian Bruhin <me@the-compiler.org> | 2023-06-12 21:42:16 +0200 |
commit | eaf71c8e410219c65b8220ac26024f8abc41f1dd (patch) | |
tree | a527d5dc304cbac60ea3dc3ac952213d837a3394 | |
parent | 9aaf08e3291a3da96e54e24f4f82b7e8f02092b9 (diff) | |
download | qutebrowser-eaf71c8e410219c65b8220ac26024f8abc41f1dd.tar.gz qutebrowser-eaf71c8e410219c65b8220ac26024f8abc41f1dd.zip |
qt: Add docstring for constants
-rw-r--r-- | qutebrowser/qt/machinery.py | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/qutebrowser/qt/machinery.py b/qutebrowser/qt/machinery.py index 1eef24f0b..71e1c832c 100644 --- a/qutebrowser/qt/machinery.py +++ b/qutebrowser/qt/machinery.py @@ -89,14 +89,34 @@ def _select_wrapper(args: Union[argparse.Namespace, None]) -> str: # Values are set in init(). If you see a NameError here, it means something tried to # import Qt (or check for its availability) before machinery.init() was called. + +#: The name of the wrapper to be used, one of WRAPPERS. +#: Should not be used directly, use one of the USE_* or IS_* constants below +#: instead, as those are supported by type checking. WRAPPER: str + +#: Whether we're using PyQt5. Consider using IS_QT5 or IS_PYQT instead. USE_PYQT5: bool + +#: Whether we're using PyQt6. Consider using IS_QT6 or IS_PYQT instead. USE_PYQT6: bool + +#: Whether we're using PySide6. Consider using IS_QT6 or IS_PYSIDE instead. USE_PYSIDE6: bool + +#: Whether we are using any Qt 5 wrapper. IS_QT5: bool + +#: Whether we are using any Qt 6 wrapper. IS_QT6: bool + +#: Whether we are using any PyQt wrapper. IS_PYQT: bool + +#: Whether we are using any PySide wrapper. IS_PYSIDE: bool + +#: The name of the package imported. PACKAGE: str _initialized = False |