Skip to content

Commit a114ec3

Browse files
authored
Update HostingEnvironmentExtensions.xml
1 parent 74f8701 commit a114ec3

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

xml/Microsoft.Extensions.Hosting/HostingEnvironmentExtensions.xml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,13 @@
7878
<Docs>
7979
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
8080
<param name="environmentName">Environment name to validate against.</param>
81-
<summary>Compares the current hosting environment name against the specified value.</summary>
81+
<summary>Compares the current hosting environment name against the specified value. Library authors should avoid using this API, see remarks for details.</summary>
8282
<returns>
8383
<see langword="true" /> if the specified name is the same as the current environment; otherwise, <see langword="false" />.</returns>
84-
<remarks>To be added.</remarks>
84+
<remarks>
85+
Environment names are generally specific to an application. Libraries designed for use in many different applications
86+
should avoid coupling behavior to specific environment names.
87+
</remarks>
8588
</Docs>
8689
</Member>
8790
<Member MemberName="IsProduction">

0 commit comments

Comments
 (0)