From db1352b7d9ce7afa0d7074c3c48dd468b312f413 Mon Sep 17 00:00:00 2001
From: Jonathan Channon <jonathan.channon@gmail.com>
Date: Mon, 20 May 2024 10:12:01 +0100
Subject: [PATCH] add xml remarks regarding dependencies

---
 src/Carter/ICarterModule.cs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/Carter/ICarterModule.cs b/src/Carter/ICarterModule.cs
index c558a67..d6b131b 100644
--- a/src/Carter/ICarterModule.cs
+++ b/src/Carter/ICarterModule.cs
@@ -234,11 +234,13 @@ public CarterModule RequireRateLimiting(string policyName)
 /// <summary>
 /// An interface to define HTTP routes
 /// </summary>
+/// <remarks>Implementations of <see cref="ICarterModule"/> should not inject constructor dependencies. All dependencies should be supplied in the route <see cref="RequestDelegate"/></remarks>
 public interface ICarterModule
 {
     /// <summary>
     /// Invoked at startup to add routes to the HTTP pipeline
     /// </summary>
+    /// <remarks>Implementations of <see cref="ICarterModule"/> should not inject constructor dependencies. All dependencies should be supplied in the route <see cref="RequestDelegate"/></remarks>
     /// <param name="app">An instance of <see cref="IEndpointRouteBuilder"/></param>
     void AddRoutes(IEndpointRouteBuilder app);
 }