Add additional examples to PowerShell helpers documentation
The examples are often not very useful.
For example here: https://github.com/chocolatey/choco/wiki/HelpersInstallChocolateyShortcut
I would expect at least one example which links from an installed package to the desktop, but the examples are all with absolute pathes and are not covering the most common cases.
@thigg if you have an example that you think would be useful, let us know, and we can get them added.
Just have an example for the old one:
$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
$target = Join-Path $toolsDir "eclipse\eclipse.exe"
Install-ChocolateyDesktopLink $target
But you got the general idea what I mean? That the examples should cover the most general usecase.
I will look through my scripts and check if there are some good examples for several functions.
Yes, I agree that we need to expand on the use cases, and this is definitely something we can add. If you come up with other use cases for as helper functions, feel free to shout, and we can get them added as well.
Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward? This issue will be closed in 14 days if it continues to be inactive.
Dear contributor,
As this issue seems to have been inactive for quite some time now, it has been automatically closed. If you feel this is a valid issue, please feel free to re-open the issue if / when a pull request has been added. Thank you for your contribution.
Just looking at this comment, the example is not valid:
Install-ChocolateyShortcutrequires both aShortcutFilePathand aTargetPathparameter.- In this example, the executable is already in the tools folder and therefore would be shimmed. So there would be no need for a shortcut.
As this is over 9 years old, and there has been no update, I'm going to go ahead and close it.