dotnet / dotnet/dotnet-api-docs
Ensure return values conform to standard pattern
- 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:

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
Assessment
This issue has not been assessed yet.