update docstrings

Author: alexander-alderman-webb

sentry_sdk/integrations/litestar.py

@@ -92,7 +92,10 @@ def __init__(
             mechanism_type="asgi",
             span_origin=span_origin,
             asgi_version=3,
-            # https://github.com/litestar-org/litestar/issues/2077
+            # Unlike Starlette, LiteStar does not extend scope["root_path"] with the mount path.
+            # Since LiteStar handles servers that include and do not include scope["root_path"] in scope["path"]
+            # with the commit below, keep the existing behavior for compatibility.
+            # https://github.com/litestar-org/litestar/commit/72dda171768bd470adc065c47c1ecf1d80b5e749
             path_includes_root_path=False,
         )
 

sentry_sdk/integrations/quart.py

@@ -102,6 +102,8 @@ async def sentry_patched_asgi_app(
             lambda *a, **kw: old_app(self, *a, **kw),
             span_origin=QuartIntegration.origin,
             asgi_version=3,
+            # Starting with the commit below, Quart treats any scope["path"]
+            # that does not include scope["root_path"] as invalid.
             # https://github.com/pallets/quart/commit/7be545c
             path_includes_root_path=version >= (0, 19),
         )

sentry_sdk/integrations/starlette.py

@@ -143,7 +143,8 @@ def setup_once() -> None:
             )
 
         patch_middlewares()
-        # See https://github.com/Kludex/starlette/commit/e8f0dcd54e4ceec47e02c45f5275374e292339ad
+        # Starlette's Mount includes scope["root_path"] in scope["path"] starting with:
+        # https://github.com/Kludex/starlette/commit/e8f0dcd54e4ceec47e02c45f5275374e292339ad.
         path_includes_root_path = version >= (0, 33)
         patch_asgi_app(path_includes_root_path=path_includes_root_path)
         patch_request_response()

sentry_sdk/integrations/starlite.py

@@ -77,7 +77,6 @@ def __init__(
             mechanism_type="asgi",
             span_origin=span_origin,
             asgi_version=3,
-            # https://github.com/litestar-org/litestar/issues/2077
             path_includes_root_path=False,
         )