From 2b0a79f8f63fc44871016e38fc01642f5678f076 Mon Sep 17 00:00:00 2001 From: Daniel Date: Thu, 14 Dec 2023 13:33:12 +0100 Subject: [PATCH] improve docstring --- recipes/authentik/tests_authentik/conftest.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/recipes/authentik/tests_authentik/conftest.py b/recipes/authentik/tests_authentik/conftest.py index 5922893..df919d9 100644 --- a/recipes/authentik/tests_authentik/conftest.py +++ b/recipes/authentik/tests_authentik/conftest.py @@ -21,10 +21,11 @@ def api_request_context( @pytest.fixture def check_if_user_exists() -> Callable[[BrowserContext, dict[str, str], BaseUrl], bool]: - """This is actually a normal function supplied as a fixture. This is because normal imports from tests_authentik is difficult. - tests_authentik is not part of the python environment, so - from ... import function - will most likely fail. However, pytest handles the loading of fixtures from conftest.py automatically, hence we use that to load functions too.""" + """This is actually a normal function supplied by a fixture. We do this, because imports from + tests_authentik are difficult as it is not part of the python environment. We expect + from X import function + to fail here. However, pytest handles the loading of fixtures from conftest.py automatically, + hence we use that to load functions too.""" def inner_check_if_user_exists(admin_context: BrowserContext, env_config: dict[str, str], URL: BaseUrl) -> bool: # go to admin page