Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

cheenamalhotra
Copy link
Member

@cheenamalhotra cheenamalhotra commented Mar 20, 2025

Fixes #3228

Modified:

  • <note> tags are not recognized by mdoc that generates .NET API Reference documentation, hence reverted them back to Markdown formatted notes.
  • 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.

Copy link

codecov bot commented Mar 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.70%. Comparing base (f3ae72a) to head (a2ba4f0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3233      +/-   ##
==========================================
- Coverage   72.73%   72.70%   -0.04%     
==========================================
  Files         288      303      +15     
  Lines       59527    59527              
==========================================
- Hits        43298    43280      -18     
- Misses      16229    16247      +18     
Flag Coverage Δ
addons 92.58% <ø> (ø)
netcore 75.14% <ø> (-0.05%) ⬇️
netfx 71.36% <ø> (-0.02%) ⬇️

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
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
3 participants