Merge pull request #211 from lsst-sqre/u/rra/doc-fix

Fix spawn_uvicorn documentation
lsst-sqre · Oct 3, 2023 · 15ed2c0 · 15ed2c0
2 parents 2f89ee2 + 21dcf82
commit 15ed2c0
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/docs/user-guide/uvicorn.rst b/docs/user-guide/uvicorn.rst
@@ -24,7 +24,7 @@ This code assumes the source code of the test app is in the variable ``_APP_SOUR
 
 
    @pytest.fixture
-   def uvicorn(tmp_path: Path) -> Iterator[UvicornProcess]:
+   def server(tmp_path: Path) -> Iterator[UvicornProcess]:
        app_path = tmp_path / "test.py"
        app_path.write_text(_APP_SOURCE)
        uvicorn = spawn_uvicorn(working_directory=tmp_path, app="test:app")
@@ -49,14 +49,14 @@ Alternately, if you need to dynamically create the application (using other fixt
 
 
    @pytest.fixture
-   def uvicorn(tmp_path: Path) -> Iterator[UvicornProcess]:
+   def server(tmp_path: Path) -> Iterator[UvicornProcess]:
        app_path = tmp_path / "test.py"
        app_path.write_text(_APP_SOURCE)
        uvicorn = spawn_uvicorn(
            working_directory=tmp_path,
            factory="tests.support.selenium:create_app",
        )
-       yield process
+       yield uvicorn
        uvicorn.process.terminate()
 
 By default, the output from Uvicorn is sent to the normal standard output and standard error, where it will be captured by pytest but will not be available to the test.