Azure / Azure/azure-sdk-tools

APIView shows more interface implementation information than is in the API

Open
#8,447 1 comment 0 reactions 0 assignees View on GitHub
.NET APIView
Dominant language
C#
Stars
135
Forks
260
Avg merge
1d 22h
Merged PRs (30d)
115

Description

It seems that APIView shows additional versions of the interfaces that a type implements, rather than the more concise notation found in the source code of the API.

For example:

[Source code](https://github.com/Azure/azure-sdk-for-net/blob/a9b25dbb78636ff19632518caa4db75e5ccdb235/sdk/core/Azure.Core/src/RequestHeaders.cs#L13);
```c#
public readonly struct RequestHeaders : IEnumerable
```

[ApiView](https://apiview.dev/Assemblies/Review/ba87b735158144eea6cabe21a2c58dde):
```c#
public readonly struct RequestHeaders : IEnumerable, IEnumerable
```

It would be nice if APIView displayed the same thing as the source code.

Contributor guide

Open the contributing guide

Research direction

Start with the RequestHeaders.cs source example and compare it with the linked APIView output to locate where inherited interface information is rendered. Trace the APIView interface-display entry point and its tests, if present; done means the display matches the concise source notation without the extra IEnumerable entry.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.