Skip to content

Add a remark to AddEvent method #4871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carlossanlop merged 2 commits into from
Sep 21, 2020
Merged

Add a remark to AddEvent method #4871

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0d2ce6
Add a remark to AddEvent method
tarekgh Sep 17, 2020
5d72f4f
Apply suggestions from code review
tarekgh Sep 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion xml/System.Diagnostics/Activity.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,17 @@ This key/value pair is included in the collection returned by the <xref:System.D
<summary>Adds the specified activity event to the events list.</summary>
<returns>
<see langword="this" /> for convenient chaining.</returns>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

`AddEvent` is not intended for adding many events over a long period of time, because the event objects are stored in memory. Adding too many events to the same `Activity` object can impact app performance.
Callers should either restrict the number of events added to the same `Activity` object or choose another logging mechanism, for example, <xref:Microsoft.Extensions.Logging?displayProperty=fullName>.

]]></format>
</remarks>

</Docs>
</Member>
<Member MemberName="AddTag">
Expand Down