chocolatey / chocolatey/docs

Clear up Install-ChocolateyPackage examples

Open
#162 0 comments 0 reactions 0 assignees View on GitHub
Documentation
Dominant language
MDX
Stars
223
Forks
248
Avg merge
3d 2h
Merged PRs (30d)
8

Description

From @chrisdent on PowerShell discord server:

>Install-ChocolateyPackage, the examples are a bit all over the place. There's variables which aren't declared in example 3 for instance. The -File parameter needs better documentation too. It's unclear if this can be used to replace Install-ChocolateyInstallPackage (my colleague was trying to use it). I can raise an issue if you like, but you guys have a fair selection of those

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the Install-ChocolateyPackage documentation and review each example, starting with example 3 and the -File parameter description. Compare the documented purpose with Install-ChocolateyInstallPackage. Done means all example variables are defined and the parameter behavior and relationship between the two commands are clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.