Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Missing item in dotnet-api-docs removes the existing item in triple slash

Open
#163 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp
Domain
documentation, tooling

Research direction

Start by running the PortToTripleSlash.exe command from the issue against the Microsoft.Extensions.Hosting.WindowsServices project and the dotnet-api-docs XML. Compare the generated triple-slash comments with the existing documentation, focusing on the removed inheritdoc and param. Done means missing XML items no longer remove existing triple-slash items.

Written by the indexing model from the issue text.

Description

port-to-tripleslash

Example:

PortToTripleSlash.exe \
  -Docs $ENV:SOURCEREPOS\dotnet-api-docs\xml 
  -CsProj $ENV:SOURCEREPOS\runtime\src\libraries\Microsoft.Extensions.Hosting.WindowsServices\src\Microsoft.Extensions.Hosting.WindowsServices.csproj 
  -IncludedAssemblies Microsoft.Extensions.Hosting.WindowsServices 
  -IncludedNamespaces Microsoft.Extensions.Hosting.WindowsServices

One inheritdoc is removed:
image

As well as a param:
image

Dominant language
C#
Stars
14
Forks
21
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dotnet/api-docs-sync

All issues in dotnet/api-docs-sync

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.