NuGet/Home

--protocolVersion argument description isn't accurate about the default value

Open

#14,008 opened on Dec 18, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)HTML (1,459 stars) (292 forks)batch import
Priority:3Product:dotnet.exeType:Bughelp wanted

Description

NuGet Product Used

dotnet.exe

Product Version

.NET 9.0.0

Worked before?

documentation issue

Impact

It bothers me. A fix would be nice

Repro Steps & Context

The description of the --protocolVersion argument isn't accurate when we do the command dotnet nuget add source --help. Currently it's

The NuGet server protocol version to be used. Currently supported versions are 2 and 3. See https://learn.microsoft.com/nuget/api/overview for information about the version 3 protocol. Defaults to 2 if not specified.

But if we refer to https://learn.microsoft.com/en-us/nuget/reference/nuget-config-file official documentation, we can read this:

The NuGet server protocol version to be used. The current version is "3". Defaults to version "2" when not pointing to a package source URL ending in .json (e.g. https://api.nuget.org/v3/index.json). Supported in NuGet 3.0+. See NuGet Server API for more information about the version 3 protocol.

The misleading here reside in the default value. When we are reading the description of nuget command line help, it says that it defaults to value 2 if there is nothing. But in the end it's not true if the source URL ending in .json according to the official documentation.

I think the description in help command should be more accurate about the default value.

Verbose Logs

No response

Contributor guide

Tech stack
csharp
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
The issue identifies a discrepancy in the help text for the ` protocolVersion` argument of `dotnet nuget add source`. The description incorrectly states a default of 2, but the official documentation indicates the default depends on the source URL ending. To resolve, locate the source code that generates this help text in the NuGet client repository (likely in NuGet/NuGet.Client). Update the description to match the official documentation, clarifying that the default is 2 unless the source URL ends in '.json', in which case it defaults to 3. No linked PRs or assignees indicate this issue is unclaimed.