-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Fix example intros #12170
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.
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
Fix example intros #12170
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR simplifies and standardizes the example documentation for the EventAttribute class. The changes focus on cleaning up redundant section headers and consolidating code snippets.
- Removes redundant "Remarks" and "Examples" headings from markdown documentation
- Consolidates multiple code snippets into single Snippet5 blocks
- Updates EventSource references from xref format to markdown links
- Adjusts snippet markers in code files to match the consolidated structure
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| xml/System.Diagnostics.Tracing/EventAttribute.xml | Cleaned up documentation structure by removing redundant headings, consolidating code snippet references, and updating EventSource cross-references to markdown links |
| snippets/visualbasic/System.Diagnostics.Tracing/EventAttribute/Overview/program.vb | Updated snippet markers to consolidate Snippet5-8 into a single Snippet5 block |
| snippets/csharp/System.Diagnostics.Tracing/EventAttribute/Overview/program.cs | Updated snippet markers to consolidate Snippet5-8 into a single Snippet5 block |
BillWagner
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This LGTM @gewarren
Did you check that the snippets this PR no longer references are still needed? If not, let's remove them.
No description provided.