Visitar URL original
Fix duplicated docs, and missing snippet ref by cheenamalhotra · Pull Request #4086 · dotnet/SqlClient · GitHub
Skip to content

Fix duplicated docs, and missing snippet ref - #4086

Merged
cheenamalhotra merged 2 commits into
mainfrom
dev/cheena/doc-changes
Apr 8, 2026
Merged

Fix duplicated docs, and missing snippet ref#4086
cheenamalhotra merged 2 commits into
mainfrom
dev/cheena/doc-changes

Conversation

@cheenamalhotra

@cheenamalhotra cheenamalhotra commented Mar 25, 2026

Copy link
Copy Markdown
Member

No description provided.

@cheenamalhotra
cheenamalhotra requested a review from a team as a code owner March 25, 2026 17:54
Copilot AI review requested due to automatic review settings March 25, 2026 17:54
@github-project-automation github-project-automation Bot moved this to To triage in SqlClient Board Mar 25, 2026
@cheenamalhotra cheenamalhotra added this to the 7.1.0-preview1 milestone Mar 25, 2026
Copilot AI reviewed Mar 25, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates SqlCommand API documentation snippets to remove duplicated inline examples and to reference specific snippet regions in sample files, improving consistency and reducing redundant content in generated docs.

Changes:

  • Updated ExecuteReader example include to reference snippet region #1 in the sample file.
  • Removed duplicated inline <example> XML blocks where markdown + [!code-csharp] includes already exist.
  • Adjusted one code include label to incorporate #1.

@cheenamalhotra cheenamalhotra added the Hotfix Candidate 🚑 Issues/PRs that are candidate for backporting to earlier supported versions. label Mar 25, 2026
priyankatiwari08
priyankatiwari08 reviewed Mar 30, 2026
View reviewed changes

@priyankatiwari08 priyankatiwari08 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: It looks like #1 was unintentionally added to the snippet label here. The path already had #1 before this PR and was correct — this change only adds #1 to the display label, which would render as "SqlCommand_ExecuteReader2#1" in the generated docs.
I believe this line should be reverted?

@paulmedynski paulmedynski added Hotfix 7.0.1 and removed Hotfix Candidate 🚑 Issues/PRs that are candidate for backporting to earlier supported versions. labels Apr 1, 2026
@paulmedynski paulmedynski self-assigned this Apr 1, 2026
paulmedynski
paulmedynski previously approved these changes Apr 1, 2026
View reviewed changes
@mdaigle mdaigle moved this from To triage to In review in SqlClient Board Apr 1, 2026
@codecov

codecov Bot commented Apr 6, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 66.52%. Comparing base (60d4b92) to head (04ac233).
⚠️ Report is 27 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (60d4b92) and HEAD (04ac233). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (60d4b92) HEAD (04ac233)
CI-SqlClient 1 0
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #4086      +/-   ##
==========================================
- Coverage   73.22%   66.52%   -6.70%     
==========================================
  Files         280      274       -6     
  Lines       43000    65801   +22801     
==========================================
+ Hits        31486    43774   +12288     
- Misses      11514    22027   +10513
Flag Coverage Δ
CI-SqlClient ?
PR-SqlClient-Project 66.52% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cheenamalhotra
cheenamalhotra enabled auto-merge (squash) April 7, 2026 15:37
@cheenamalhotra
cheenamalhotra merged commit 4c294c6 into main Apr 8, 2026
299 checks passed
@cheenamalhotra
cheenamalhotra deleted the dev/cheena/doc-changes branch April 8, 2026 10:04
@github-project-automation github-project-automation Bot moved this from In review to Done in SqlClient Board Apr 8, 2026
github-actions Bot pushed a commit that referenced this pull request Apr 8, 2026
@cheenamalhotra @github-actions
Fix duplicated docs, and missing snippet ref (#4086)
67a6af4
@github-actions github-actions Bot mentioned this pull request Apr 8, 2026
Merged
paulmedynski pushed a commit that referenced this pull request Apr 9, 2026
@cheenamalhotra @paulmedynski
Fix duplicated docs, and missing snippet ref (#4086)
32ab7b4
This was referenced Apr 24, 2026
Merged
Closed
Closed
This was referenced Nov 6, 2026
Open
Closed
Open
Open
Merged
Open
Closed
Closed
Closed
Open
Merged
Closed
Merged
Open
Open
@MZurmuehlen89 MZurmuehlen89 mentioned this pull request Nov 10, 2026
Closed
This was referenced Nov 10, 2026
Open
Closed
Open
Closed
Merged
Merged
Open
Open
Open
Open
Open
Open
Open
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@priyankatiwari08 priyankatiwari08 priyankatiwari08 left review comments
@apoorvdeshmukh apoorvdeshmukh apoorvdeshmukh approved these changes
@paulmedynski paulmedynski paulmedynski approved these changes

Assignees

@paulmedynski paulmedynski

Labels

None yet

Projects

SqlClient Board
Status: Done

Milestone

7.1.0-preview1

Development

Successfully merging this pull request may close these issues.

5 participants

@cheenamalhotra @apoorvdeshmukh @paulmedynski @priyankatiwari08