docs icon indicating copy to clipboard operation
docs copied to clipboard

Undocumented softwareName parameter in package function examples

Open HunterZ opened this issue 4 years ago • 1 comments

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

N/A

HunterZ avatar Dec 12 '21 21:12 HunterZ

I've transferred this over to the docs repository.

pauby avatar Dec 13 '21 14:12 pauby