From 437438d2422d8719028a00176a4d914ed92e1fff Mon Sep 17 00:00:00 2001
From: Philipp Albrecht <philipp.albrecht@momox.biz>
Date: Fri, 12 Nov 2021 16:37:25 +0100
Subject: Add docstring to _select_backend()

---
 tests/conftest.py | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/tests/conftest.py b/tests/conftest.py
index e1787fc83..ee4572fad 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -226,6 +226,25 @@ def pytest_configure(config):
 
 
 def _select_backend(config):
+    """Select the backend for running tests.
+
+    The backend is auto-selected in the following manner:
+    1. Use QtWebKit if available
+    2. Otherwise use QtWebEngine as a fallback
+
+    Auto-selection is overridden by either passing a backend via
+    `--qute-bdd-backend=<backend>` or setting the environment variable
+    `QUTE_BDD_BACKEND=<backend>`.
+
+    Args:
+        config: pytest config
+
+    Raises:
+        ImportError if the selected backend is not available.
+
+    Returns:
+        The selected backend as a string (e.g. 'webkit').
+    """
     backend_arg = config.getoption('--qute-bdd-backend')
     backend_env = os.environ.get('QUTE_BDD_BACKEND')
 
-- 
cgit v1.2.3-54-g00ecf