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

Update nuget.exe help for high level command descriptions #1774

Open
emgarten opened this issue Nov 25, 2015 · 1 comment
Open

Update nuget.exe help for high level command descriptions #1774

emgarten opened this issue Nov 25, 2015 · 1 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:NuGet.exe NuGet.exe Type:Bug

Comments

@emgarten
Copy link
Member

The high level help for nuget.exe contains grammatical errors and typos. It also calls out the machine wide nuget.config in many of the descriptions as the only config source which is likely not the case for many scenarios.

Steps

  1. nuget.exe (no parameters)
  2. read the help

Issues

  1. Add and Init provide an https url to the docs, but the url at the bottom is http. It should be consistent.
  2. Add and Init should say “go to” instead of “goto”
  3. The description for “help (?)” is confusing. (2.8.6 has the same text)
  4. The description for delete does not accurately describe the command. In many cases delete unlists the package. The command also works for local sources, not just servers.
  5. There is a word missing from the install description. What uses the default feed? (2.8.6 has the same text)
  6. setApiKey is possibly missing a word, I’m not sure what it is trying to say. “When no URL is provided API key is saved for the NuGet gallery.” (2.8.6 has the same text)
  7. For sources the description is grammatically incorrect and may also be incorrect in general since other nuget.config files could be updated. (2.8.6 has the same text)
  8. Push gives a full description of how nuget.config works. The same is true for all other commands which makes it unneeded and confusing for push.
NuGet Version: 3.3.0.205
usage: NuGet <command> [args] [options]
Type 'NuGet help <command>' for help on a specific command.

Available commands:

 add         Adds the given package to a hierarchical source. http sources are not supported. For more info, goto https
             ://docs.nuget.org/consume/command-line-reference#add-command.

 config      Gets or sets NuGet config values.

 delete      Deletes a package from the server.

 help (?)    Displays general help information and help information about other commands.

 init        Adds all the packages from the <srcPackageSourcePath> to the hierarchical <destPackageSourcePath>. http fe
             eds are not supported. For more info, goto https://docs.nuget.org/consume/command-line-reference#init-comm
             and.

 install     Installs a package using the specified sources. If no sources are specified, all sources defined in the Nu
             Get configuration file are used. If the configuration file specifies no sources, uses the default NuGet fe
             ed.

 list        Displays a list of packages from a given source. If no sources are specified, all sources defined in %AppD
             ata%\NuGet\NuGet.config are used. If NuGet.config specifies no sources, uses the default NuGet feed.

 locals      Clears or lists local NuGet resources such as http requests cache, packages cache or machine-wide global p
             ackages folder.

 pack        Creates a NuGet package based on the specified nuspec or project file.

 push        Pushes a package to the server and publishes it.
             NuGet's default configuration is obtained by loading %AppData%\NuGet\NuGet.config, then loading any nuget.
             config or .nuget\nuget.config starting from root of drive and ending in current directory.

 restore     Restores NuGet packages.

 setApiKey   Saves an API key for a given server URL. When no URL is provided API key is saved for the NuGet gallery.

 sources     Provides the ability to manage list of sources located in %AppData%\NuGet\NuGet.config

 spec        Generates a nuspec for a new package. If this command is run in the same folder as a project file (.csproj
             , .vbproj, .fsproj), it will create a tokenized nuspec file.

 update      Update packages to latest available versions. This command also updates NuGet.exe itself.

For more information, visit http://docs.nuget.org/docs/reference/command-line-reference
@yishaigalatzer yishaigalatzer added this to the 3.4 milestone Dec 31, 2015
@yishaigalatzer yishaigalatzer added Priority:2 Issues for the current backlog. Type:Bug help wanted Considered good issues for community contributions. labels Dec 31, 2015
@yishaigalatzer yishaigalatzer modified the milestones: 3.4 Beta, 3.4 RTM Feb 25, 2016
@yishaigalatzer yishaigalatzer modified the milestones: 3.4 RTM, 3.4 RTM - Triage, 3.5 Beta Mar 11, 2016
@yishaigalatzer yishaigalatzer modified the milestones: 3.5 Beta, 3.5 RC Apr 8, 2016
@emgarten emgarten added the Product:NuGet.exe NuGet.exe label Jun 15, 2016
@emgarten emgarten removed their assignment Feb 14, 2017
@mido3ds
Copy link

mido3ds commented Jun 8, 2017

I am willing to work on this issue

and wants to ask some questions, if you don't mind

considering issue number:
(3) what is confusing exactly? it seems clear to me

(6) setApiKey doesn't seem to miss any words, it's complete. But we could add comma ',' after "provided" to clarify what will be saved

I think it should be "When no URL is provided, API key is saved for the NuGet gallery."

(7) Could you point out the grammar error? it seems ok

Thanks for your time.

@nkolev92 nkolev92 removed this from the Backlog milestone Sep 29, 2020
@nkolev92 nkolev92 added Priority:3 Issues under consideration. With enough upvotes, will be reconsidered to be added to the backlog. and removed Priority:2 Issues for the current backlog. labels Apr 3, 2023
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:NuGet.exe NuGet.exe Type:Bug
Projects
None yet
Development

No branches or pull requests

7 participants