Skip to content

Fix ThreadState example formatting in table using HTML#51534

Merged
meaghanlewis merged 3 commits intomainfrom
copilot/fix-threadstate-example-formatting
Feb 6, 2026
Merged

Fix ThreadState example formatting in table using HTML#51534
meaghanlewis merged 3 commits intomainfrom
copilot/fix-threadstate-example-formatting

Conversation

Copy link
Contributor

Copilot AI commented Feb 5, 2026

The ThreadState command example was embedded inline within a table cell using backticks, causing rendering issues and poor readability.

Changes

  • Fixed inline formatting: Replaced single-line backtick formatting with HTML <pre> tags and <br /> line breaks to properly display the multi-line example within the table cell
  • Preserved table structure: Kept the example in the table as requested, maintaining immediate accessibility alongside the command description
  • Improved readability: The example now displays with proper line breaks, spacing, and monospace formatting while remaining in the table

Before

Table cell contained backtick-wrapped multi-line output causing layout issues:

|**ThreadState**|... Example:<br /><br /> `0:003> !Threads ... !ThreadState b220 ...`|

After

Table cell with properly formatted HTML for multi-line display:

|**ThreadState**|... Example:<br /><br /><pre>0:003> !Threads<br />ThreadCount: 2<br />...<br />0:003> !ThreadState b220<br />    Legal to Join<br />    Background<br />...</pre>|

The example output now renders correctly with proper formatting while staying within the table structure.

Original prompt

This section details on the original issue you should resolve

<issue_title>Broken example formatting</issue_title>
<issue_description>The example for ThreadState has its formatting broken.

And it doesn't seem to have an up to date output.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Comments on the Issue (you are @copilot in this section)

@mairaw I don't have SOS configured right now. Do you have an up to date output I could use to update the article?

/cc @vivmishra who could help me to get an updated output for the ThreadState example?</comment_new>
<comment_new>@dotnet-bot
This issue has been closed as part of the issue backlog grooming process outlined in #22351.

That automated process may have closed some issues that should be addressed. If you think this is one of them, reopen it with a comment explaining why. Tag the @dotnet/docs team for visibility.</comment_new>
<comment_new>@mairaw
Fixing the sample formatting should be an easy fix.</comment_new>
<comment_new>@BillWagner
reopening per request.

This is not quite as simple because the sample is in a table, so it will need to be moved out of the table to make the proper formatting.</comment_new>


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.


Internal previews

📄 File 🔗 Preview link
docs/framework/tools/sos-dll-sos-debugging-extension.md docs/framework/tools/sos-dll-sos-debugging-extension

Co-authored-by: meaghanlewis <10103121+meaghanlewis@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix broken example formatting for ThreadState Extract ThreadState example from table to fix formatting Feb 5, 2026
Copilot AI requested a review from meaghanlewis February 5, 2026 22:25
@meaghanlewis
Copy link
Contributor

@copilot I didn't want the example output in a separate section. Can you fix formatting and keep the output in the table?

Co-authored-by: meaghanlewis <10103121+meaghanlewis@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 5, 2026

@copilot I didn't want the example output in a separate section. Can you fix formatting and keep the output in the table?

Updated the formatting to keep the example in the table using HTML pre tags with line breaks for proper display. See commit f11f4b0.

Copilot AI changed the title Extract ThreadState example from table to fix formatting Fix ThreadState example formatting in table using HTML Feb 5, 2026
@meaghanlewis meaghanlewis marked this pull request as ready for review February 5, 2026 22:56
@meaghanlewis meaghanlewis requested review from a team and gewarren as code owners February 5, 2026 22:56
Copilot AI review requested due to automatic review settings February 5, 2026 22:56
@meaghanlewis meaghanlewis enabled auto-merge (squash) February 5, 2026 22:59
Copy link
Contributor

Copilot AI left a 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 pull request fixes broken formatting of the ThreadState command example in the SOS debugging extension documentation. The example was previously wrapped in single-line backticks within a table cell, causing rendering and readability issues. The fix uses HTML <pre> tags with <br /> line breaks to properly display the multi-line code example while keeping it within the table structure.

Changes:

  • Replaced inline backtick formatting with HTML <pre> tags and <br /> elements for the ThreadState example
  • Maintained the example within the command reference table as requested
  • Improved readability by properly separating lines in the example output

@meaghanlewis meaghanlewis merged commit 6e87736 into main Feb 6, 2026
19 checks passed
@meaghanlewis meaghanlewis deleted the copilot/fix-threadstate-example-formatting branch February 6, 2026 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken example formatting

4 participants