From 94fab797716895235e2c9dd3c47355d29bfc38b7 Mon Sep 17 00:00:00 2001
From: Ryan Nowak <rynowak@microsoft.com>
Date: Sun, 14 Apr 2019 13:43:54 -0700
Subject: [PATCH] Add some cool docs about IDynamicEndpointMetadata.

This will make James happy, which makes it more likely he will
look at the rest of the PR.
---
 src/Http/Routing/src/Matching/MatcherPolicy.cs | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/Http/Routing/src/Matching/MatcherPolicy.cs b/src/Http/Routing/src/Matching/MatcherPolicy.cs
index f3fdc05fb1..c15085aaf0 100644
--- a/src/Http/Routing/src/Matching/MatcherPolicy.cs
+++ b/src/Http/Routing/src/Matching/MatcherPolicy.cs
@@ -34,6 +34,18 @@ namespace Microsoft.AspNetCore.Routing
         /// </summary>
         /// <param name="endpoints">The set of endpoints.</param>
         /// <returns><c>true</c> if a dynamic endpoint is found; otherwise returns <c>false</c>.</returns>
+        /// <remarks>
+        /// <para>
+        /// The presence of <see cref="IDynamicEndpointMetadata"/> signifies that an endpoint that may be replaced 
+        /// during processing by an <see cref="IEndpointSelectorPolicy"/>.
+        /// </para>
+        /// <para>
+        /// An implementation of <see cref="INodeBuilderPolicy"/> should also implement <see cref="IEndpointSelectorPolicy"/>
+        /// and use its <see cref="IEndpointSelectorPolicy"/> implementation when a node contains a dynamic endpoint.
+        /// <see cref="INodeBuilderPolicy"/> implementations rely on caching of data based on a static set of endpoints. This
+        /// is not possible when endpoints are replaced dynamically.
+        /// </para>
+        /// </remarks>
         protected static bool ContainsDynamicEndpoints(IReadOnlyList<Endpoint> endpoints)
         {
             if (endpoints == null)