1

Closed

get-package cmdlet help is confusing / misphrased

description

the help for Get-Package has a synopsis that's confusing. I would guess that maybe Get-Package used to just list available packages (or did so by default) and when that change happened, this bit of help text wasn't modified.

Both files under src\VsConsole\PowerShellCmdlets\Help are affected AFAICT:
The synopsis text:
Gets the set of packages available from the package source. Use the -ListAvailable flag to list packages available from the package source.
The next paragraph is a little better, since it repeats those same two sentences, but adds a third between them to at least explain what the default behavior is (the synopsis doesn't do so, since it doesn't mention anything about installed packages).
Gets the set of packages available from the package source. Defaults to only showing the list of installed packages. Use the -ListAvailable flag to list packages available from the package source.
One thing that's not intuitively obvious (at least to me) and would be great to include in this text if possible: whether packages installed locally that are no longer in the upstream repository will be included in the output of just 'Get-Package' (with no parameters).

Relatively recently, I (and I'd imagine many others) were bitten by the 'rename' (although no 30x, so really just delete + add) of the CommonServiceLocator.NinjectAdapter package, which was replaced with CommonServiceLocator.NinjectAdapter.Unofficial
It's clear that someone may have a package installed locally that's no longer on the main feed, so while I assume the 'Get-Package' behavior just looks locally and doesn't intersect the local set of packages with the ones from the feed, it would be nice to have that clarified in the help for Get-Package if possible.

Thanks!!
Closed Mar 14 at 9:00 PM by RanjiniM

comments

dotnetjunky wrote Mar 30, 2013 at 2:40 PM

would you care to send a pull request?

feiling wrote Jan 6 at 11:24 PM

Fixed in changeset fca7522224fad14e174a0cb3112eb2e5e2a453f8