Skip to content

Fix XML docs for WhenCalled.Throws#934

Merged
304NotModified merged 1 commit intonsubstitute:mainfrom
kerego:when-called-docs-fix
Dec 13, 2025
Merged

Fix XML docs for WhenCalled.Throws#934
304NotModified merged 1 commit intonsubstitute:mainfrom
kerego:when-called-docs-fix

Conversation

@kerego
Copy link
Copy Markdown
Contributor

@kerego kerego commented Dec 13, 2025

Was trying to understand why there are two similar methods with same descriptions, and noticed Throws has additional details that aren't picked up by vscode due to those details being outside summary/remarks.

Added the remarks tag around preferred method docs so that editors can pick it up and display.
I've looked for other cases like this and this seems to be the only file which this issue.

@304NotModified 304NotModified changed the title Fix WhenCalled.Throws xml docs remark not displayed due to missing tag Fix XML docs for WhenCalled.Throws Dec 13, 2025
Copy link
Copy Markdown
Contributor

@304NotModified 304NotModified left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@304NotModified 304NotModified merged commit 6e5045f into nsubstitute:main Dec 13, 2025
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.

2 participants