Add XML docs for query execution extensions#783
Open
Rajesh270712 wants to merge 1 commit into
Open
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
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.
Summary
SqlKata.Execution/Query.Extensions.cs.Linked issue / bounty
Problem
The public execution extension APIs currently have no XML comments, so IDE consumers do not get inline summaries, parameter descriptions, return-value descriptions, or cancellation-token guidance for these helpers.
Fix
This PR adds XML summaries,
<param>,<returns>, and relevant async/cancellation notes for the public methods inQuery.Extensions.cswithout changing runtime code, signatures, dependencies, or generated files.Tests
git diff --check HEAD^ HEADpublic_members=62,missing_xml_docs=0dotnet restoredotnet build --no-restorepassed with0 Warning(s)and0 Error(s)dotnet test --no-restore --no-build --filter 'FullyQualifiedName!~MySqlExecutionTest'passed:334passed,1skipped,0faileddotnet test --no-restore --no-buildwas also attempted; it reached334passed and1skipped, with9failures from the MySQL integration fixture becauseSQLKATA_MYSQL_HOST/ a MySQL test service was not configured in this environmentRisk / maintainer notes
SqlKata.Execution/Query.Extensions.cs.