Azure / Azure/azure-sdk-tools

Consider excluding placeholder numbered parameters when one isn't declared in the header

Open
#3,094 4 comments 0 reactions 0 assignees View on GitHub
APIView bug C++
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

We show numbered placeholder parameters in APIView on methods that don't have any named parameters. I am not sure what the best behavior is here that we'd want.

https://apiview.dev/Assemblies/Review/3226949419594af785233c8289dd76ef?diffRevisionId=ad1fbf1c658a4d95976e096a3e1438d5&doc=False&diffOnly=False&revisionId=6b2bdbdb189442bda768b7686b735c7e

https://github.com/Azure/azure-sdk-for-cpp/blob/ddc9eb355f48cbeb0159bc49cc6937ea885d3677/sdk/core/azure-core/inc/azure/core/internal/client_options.hpp#L62

![image](https://user-images.githubusercontent.com/6527137/162076285-27e90fe4-d622-4743-a93c-907845417dd1.png)

cc @LarryOsterman, @vhvb1989

Contributor guide

Open the contributing guide

Research direction

Start with the APIView diff for assembly 3226949419594af785233c8289dd76ef and inspect client_options.hpp around line 62 to understand how the numbered placeholders are rendered. Clarify the expected behavior for methods without named parameters, then identify the APIView entry point and tests that cover this rendering; done means the agreed behavior is represented consistently in the review output.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, csharp
Domain
tooling
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.