]> git.ipfire.org Git - thirdparty/starlette.git/commitdiff
Fix link title for contextvars.ContextVar (#2913)
authorAndrii Hryniv <andri1gryniv@gmail.com>
Fri, 28 Mar 2025 15:30:37 +0000 (17:30 +0200)
committerGitHub <noreply@github.com>
Fri, 28 Mar 2025 15:30:37 +0000 (15:30 +0000)
docs/middleware.md

index 01d0afcfbd147424cfcf70ad66a69fc37edb133b..f7cc23936fdfd1518c9364104033df57981fcd7a 100644 (file)
@@ -297,7 +297,7 @@ around explicitly, rather than mutating the middleware instance.
 
 Currently, the `BaseHTTPMiddleware` has some known limitations:
 
-- Using `BaseHTTPMiddleware` will prevent changes to [`contextlib.ContextVar`](https://docs.python.org/3/library/contextvars.html#contextvars.ContextVar)s from propagating upwards. That is, if you set a value for a `ContextVar` in your endpoint and try to read it from a middleware you will find that the value is not the same value you set in your endpoint (see [this test](https://github.com/encode/starlette/blob/621abc747a6604825190b93467918a0ec6456a24/tests/middleware/test_base.py#L192-L223) for an example of this behavior).
+- Using `BaseHTTPMiddleware` will prevent changes to [`contextvars.ContextVar`](https://docs.python.org/3/library/contextvars.html#contextvars.ContextVar)s from propagating upwards. That is, if you set a value for a `ContextVar` in your endpoint and try to read it from a middleware you will find that the value is not the same value you set in your endpoint (see [this test](https://github.com/encode/starlette/blob/621abc747a6604825190b93467918a0ec6456a24/tests/middleware/test_base.py#L192-L223) for an example of this behavior).
 
 To overcome these limitations, use [pure ASGI middleware](#pure-asgi-middleware), as shown below.