dotnet / dotnet/dotnet-api-docs

Ensure return values conform to standard pattern

Open
#1,358 0 comments 0 reactions 0 assignees View on GitHub
area-System.Runtime help wanted Pri3
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

## Ensure return values conform to standard pattern

OPS displays return value information as follows:

![image](https://user-images.githubusercontent.com/10886961/49889738-1ff99580-fdf7-11e8-9865-da2d5cd61ec0.png)

The only authored content is the description itself, which should describe the return value, optimally without repeating the return type.

In many case, the return value description doesn't conform to this pattern. The most egregious violation of it, and one that we should eliminate, is:

> "return-type-as-authored-content"
> "return value description, usually including return type as well"

This duplicates (and sometimes even triples) the return type. We should identify and modify these instances to that they conform to the standard pattern.

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.