chocolatey / chocolatey/docs

Undocumented softwareName parameter in package function examples

Open
#308 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
MDX
Stars
223
Forks
248
Avg merge
1d 26m
Merged PRs (30d)
4

Description

### What You Are Seeing?
The online documentation for multiple Chocolatey PowerShell packaging functions include examples referencing a `softwareName` parameter that isn't explained in those functions' documentation.

At a minimum, the following documentation pages are affected:
https://docs.chocolatey.org/en-us/create/functions/install-chocolateypackage
https://docs.chocolatey.org/en-us/create/functions/install-chocolateyinstallpackage

This implies that there is either an undocumented `softwareName` parameter supported by these functions, or that the examples confusingly include use of unsupported parameters.

### What is Expected?
All supported parameters should be documented.
No example should depict use of unsupported parameters.

### How Did You Get This To Happen? (Steps to Reproduce)
Consulted URLs above.

### Output Log

Full Log Output

~~~sh
N/A
~~~

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.