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

Powershell reference is not complete #2107

Closed
alpaix opened this issue Feb 12, 2016 · 4 comments
Closed

Powershell reference is not complete #2107

alpaix opened this issue Feb 12, 2016 · 4 comments
Milestone

Comments

@alpaix
Copy link

alpaix commented Feb 12, 2016

Package Manager Console Powershell Reference should include among others:

  • Command and argument aliases where applicable;
  • Position;
  • Default value;
  • Whether cmdlet accepts pipeline input.

For reference, see typical documentation page here https://technet.microsoft.com/en-us/library/hh849901.aspx.

@yishaigalatzer
Copy link

@alpaix please provide more details, what reference are you referring to (docs.nuget.org ? somewhere else)

@alpaix
Copy link
Author

alpaix commented Feb 25, 2016

@yishaigalatzer Updated description with official NuGet documentation page link.

Also attaching an image from TechNet as a reference example for full parameters documentation:
image

@kraigb
Copy link

kraigb commented Jun 5, 2017

@alpaix I've completed an overhaul of the reference, see https://docs.microsoft.com/en-us/nuget/tools/powershell-reference, which has the different commands broken out into individual topics.

I didn't go quite so far as to match the references you point. First, I see the open sentences on those references pages and the description sections redundant, so the description is simply at the top. Second, there is very little variance with parameters among the NuGet commands--only a few are required, only a few have default values, they are almost always named instead of positional, and none of them accept pipeline input or wildcards. For this reason, I list the arguments (with the occasional "required" and default value) in more concise tables; investing the time to break them out into the extended details would add a lot of text and visual noise without, in my opinion, adding any value.

Those details are, by the way, available by doing get-help -full, which is what I used to reconcile the arguments and their details.

I hope this is satisfactory. If not, it's worth noting that breaking out all the extended details to exactly match the TechNet references will be a significantly lower priority for the docs compared with many other extant issues.

@rrelyea
Copy link
Contributor

rrelyea commented Oct 17, 2017

Thanks @kraigb .
/cc @alpaix who moved teams.
/cc @karann-msft as well.

@rrelyea rrelyea closed this as completed Oct 17, 2017
@rrelyea rrelyea modified the milestones: Future-1, 4.3 Oct 17, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants