Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
tremblaysimon opened this issue Dec 18, 2024 · 0 comments
Labels
help wanted Considered good issues for community contributions. Priority:3 Issues under consideration. With enough upvotes, will be reconsidered to be added to the backlog. Product:dotnet.exe Type:Bug

Comments

@tremblaysimon
Copy link

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

@jeffkl jeffkl added Priority:3 Issues under consideration. With enough upvotes, will be reconsidered to be added to the backlog. help wanted Considered good issues for community contributions. labels Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Considered good issues for community contributions. Priority:3 Issues under consideration. With enough upvotes, will be reconsidered to be added to the backlog. Product:dotnet.exe Type:Bug
Projects
None yet
Development

No branches or pull requests

3 participants