Fix incorrect exception type in DataTableReader.GetOrdinal documentation #11461
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: jeffhandley <[email protected]>
Copilot finished work on behalf of
jeffhandley
June 17, 2025 08:58
jeffhandley
approved these changes
Jun 17, 2025
|
@gewarren I don't understand why this change is resulting in the OpenPublishing.Build warnings for unaffected files. You? |
gewarren
approved these changes
Jun 18, 2025
That was a transient warning that appears from time to time. Close/reopen made it go away. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation for
DataTableReader.GetOrdinal(string name)incorrectly stated in the Remarks section that anIndexOutOfRangeExceptionis thrown when a column name is not found. This contradicted both the method's Exceptions section and the supporting code examples, which correctly indicate that anArgumentExceptionis thrown.Changes Made
xml/System.Data/DataTableReader.xmlto changeIndexOutOfRangeExceptiontoArgumentExceptionin the remarks sectionVerification
The fix aligns the documentation with:
ArgumentExceptionfor invalid column namesArgumentExceptionwhen callingGetOrdinalThis is a minimal documentation-only change that resolves the inconsistency without affecting any functionality.
Fixes #11442.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.