Azure / Azure/azure-sdk-tools

apiviewgo includes exported methods of inaccessible types

Open
#10,242 1 comment 0 reactions 0 assignees View on GitHub
APIView bug Go
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 2h
Merged PRs (30d)
130

Description

For example, when run on azidentity at https://github.com/Azure/azure-sdk-for-go/commit/423de74c610bd584529ec5a1a0ef26f47cd48b90, apiviewgo includes `func (*managedIdentityClient) CloseIdleConnections()` in its output. `managedIdentityClient` shouldn't appear in API View because it can't be accessed by application code.

Contributor guide

Open the contributing guide

Research direction

Start by reproducing apiviewgo against the azidentity commit 423de74c610bd584529ec5a1a0ef26f47cd48b90 and inspect how exported methods are selected for API View. Done means methods such as managedIdentityClient.CloseIdleConnections are excluded when their receiver type is inaccessible to application code.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.