dotnet / dotnet/dotnet-api-docs

IntelliSense: Remove tables from return value section

Open
#2,264 0 comments 0 reactions 0 assignees View on GitHub
area-Infrastructure doc-enhancement Pri1 Pri3
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

# IntelliSense: Remove tables from return value section

The Return Value section of a number of methods (particularly the Compare method) includes a table that lists possible return value ranges. The table creates a broken experience for IntelliSense. The tables need to be removed and replaced with text.

PR dotnet/dotnet-api-docs#245 changes the return value section of the [IComparer.Compare](https://docs.microsoft.com/en-us/dotnet/api/system.collections.icomparer.compare?view=netframework-4.7.2#System_Collections_IComparer_Compare_System_Object_System_Object_) method, which can be examined in OPS IntelliSense builds.

//cc @mairaw @weshaggard

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.