Update HostingEnvironmentExtensions.xml

Author: analogrelay

xml/Microsoft.Extensions.Hosting/HostingEnvironmentExtensions.xml

@@ -44,10 +44,13 @@
       </Parameters>
       <Docs>
         <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
-        <summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />.</summary>
+        <summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />. This API should not be used in libraries, see remarks for details.</summary>
         <returns>
           <see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />; otherwise, <see langword="false" />.</returns>
-        <remarks>To be added.</remarks>
+        <remarks>
+          The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
+          authors should avoid coupling specific behavior to these environment names.
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="IsEnvironment">
@@ -104,10 +107,13 @@
       </Parameters>
       <Docs>
         <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
-        <summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />.</summary>
+        <summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />. This API should not be used in libraries, see remarks for details.</summary>
         <returns>
           <see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />; otherwise, <see langword="false" />.</returns>
-        <remarks>To be added.</remarks>
+        <remarks>
+          The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
+          authors should avoid coupling specific behavior to these environment names.
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="IsStaging">
@@ -133,10 +139,13 @@
       </Parameters>
       <Docs>
         <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
-        <summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />.</summary>
+        <summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />. This API should not be used in libraries, see remarks for details.</summary>
         <returns>
           <see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />; otherwise, <see langword="false" />.</returns>
-        <remarks>To be added.</remarks>
+        <remarks>
+          The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
+          authors should avoid coupling specific behavior to these environment names.
+        </remarks>
       </Docs>
     </Member>
   </Members>