dotnet / dotnet/dotnet-api-docs

Class description of `System.Diagnostics.Debug` is different between online and XML doc

Open
#9,907 2 comments 0 reactions 0 assignees View on GitHub
area-System.Diagnostics Pri3 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

The class description of `System.Diagnostics.Debug` online is "Provides a set of methods and properties that **help debug your code**."

https://github.com/dotnet/dotnet-api-docs/blob/bc5c3d5ff54f8bea2f49aa32a940111e89bfd574/xml/System.Diagnostics/Debug.xml#L68

But the class description of `System.Diagnostics.Debug` from actual source code is "Provides a set of properties and methods **for debugging code.**"

https://github.com/dotnet/runtime/blob/2d7eea252964e69be94cb9c847b371b23e4dd470/src/libraries/System.Private.CoreLib/src/System/Diagnostics/Debug.cs#L15-L17

Coming with a Java background, I was always under the impression that the API reference (MSDN) is generated from XML documentation from the actual source code, plus extra long examples and remarks.

I'm all in favor of extra remarks, usages, and code examples that do not fit in Visual Studio tooltip, but why does the one sentence description of System.Diagnostics.Debug differ?

Can anyone educate me on the workflow or the advantage in doing so?

Also would you like to update the summary element in https://github.com/dotnet/dotnet-api-docs/blob/bc5c3d5ff54f8bea2f49aa32a940111e89bfd574/xml/System.Diagnostics/Debug.xml and match the actual source code, and cause less confusion?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.