Skip to content

Fix comment format in WorkItemTools.cs#5

Merged
gadeynebram merged 1 commit into
mainfrom
fix/wit_comment_format
May 15, 2026
Merged

Fix comment format in WorkItemTools.cs#5
gadeynebram merged 1 commit into
mainfrom
fix/wit_comment_format

Conversation

@gadeynebram
Copy link
Copy Markdown
Owner

This pull request updates the XML documentation and descriptions for methods related to adding and updating work item comments in Azure DevOps. The changes clarify that comments are stored as rich text (typically HTML) and may include various HTML elements, providing more accurate guidance for users of these APIs.

Documentation improvements:

  • Updated the XML documentation for the AddWorkItemComment and UpdateWorkItemComment methods in WorkItemTools.cs to clarify that comment content is stored as rich text (HTML) and may include markup such as <div>, <br>, &nbsp;, <span>, lists, and other formatting elements. [1] [2]
  • Improved the method descriptions to remove references to only plain text or simple HTML formatting, and instead describe support for a broader range of HTML elements. [1] [2]

@gadeynebram gadeynebram merged commit bbc03e8 into main May 15, 2026
2 checks passed
@gadeynebram gadeynebram deleted the fix/wit_comment_format branch May 15, 2026 12:22
@github-actions
Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant