Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Trim XML documentation for reference project + fix Note tags - #3233

#3233
Merged
cheenamalhotra merged 19 commits into
maindotnet/SqlClient:mainfrom
dev/cheena/fix-api-docsdotnet/SqlClient:dev/cheena/fix-api-docsCopy head branch name to clipboard
Apr 16, 2025
Merged

Trim XML documentation for reference project + fix Note tags#3233
cheenamalhotra merged 19 commits into
maindotnet/SqlClient:mainfrom
dev/cheena/fix-api-docsdotnet/SqlClient:dev/cheena/fix-api-docsCopy head branch name to clipboard

Conversation

@cheenamalhotra

@cheenamalhotra cheenamalhotra commented Mar 20, 2025

Copy link
Copy Markdown
Member

Fixes #3228

Modified:

  • <note> tags are not recognized by mdoc that generates .NET API Reference documentation, hence reverted them back to Markdown formatted notes.
    • This involved changing back the remarks and example sections to markdown format where Notes were defined.
  • Remarks and Examples make VS Intellisense too long, for even System.Runtime APIs don't contain them. This PR trims them down from XML docs file included in the 'ref' directory that's used by VS Intellisense. The root 'lib' directory's XML files contains full docs that are picked up to be published at .NET API Reference.

These changes have been validated at the API Docs PR: https://github.com/dotnet/sqlclient-api-docs/pull/79, I will be backporting them to release/6.0 and republishing 6.0.2 specific changes.

@codecov

codecov Bot commented Mar 20, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.04%. Comparing base (61e2317) to head (9f81b9e).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3233      +/-   ##
==========================================
+ Coverage   72.81%   73.04%   +0.23%     
==========================================
  Files         297      296       -1     
  Lines       59661    57257    -2404     
==========================================
- Hits        43440    41825    -1615     
+ Misses      16221    15432     -789     
Flag Coverage Δ
addons 92.58% <ø> (ø)
netcore 75.27% <ø> (+0.08%) ⬆️
netfx 71.46% <ø> (-0.03%) ⬇️

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.

@paulmedynski paulmedynski self-assigned this Mar 21, 2025
@cheenamalhotra cheenamalhotra added this to the 6.1-preview1 milestone Mar 29, 2025
@mdaigle mdaigle self-assigned this Apr 2, 2025
@cheenamalhotra
cheenamalhotra marked this pull request as ready for review April 4, 2025 22:52
@cheenamalhotra
cheenamalhotra requested a review from a team April 4, 2025 22:54

@paulmedynski paulmedynski 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.

Some formatting and a couple of questions.

Comment thread doc/snippets/Microsoft.Data.Sql/SqlDataSourceEnumerator.xml Outdated
Comment thread doc/snippets/Microsoft.Data.SqlClient/SqlBulkCopy.xml Outdated
Comment thread doc/snippets/Microsoft.Data.SqlClient/SqlBulkCopy.xml
Comment thread doc/snippets/Microsoft.Data.SqlClient/SqlBulkCopy.xml
Comment thread doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml
Comment thread doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml
Comment thread doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml
Comment thread doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml
Comment thread doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml
Comment thread doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml
Comment thread doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml

@paulmedynski paulmedynski 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.

I think the tab -> space work is still outstanding.

@cheenamalhotra

Copy link
Copy Markdown
Member Author

I think the tab -> space work is still outstanding.

Changed all to spaces.

@cheenamalhotra
cheenamalhotra requested review from a team and paulmedynski April 10, 2025 20:51
@cheenamalhotra
cheenamalhotra requested a review from mdaigle April 14, 2025 18:45
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.

Fix .NET API reference docs

4 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.