Installation of Chocolatey should add a more descriptive comment when adding Chocolatey tab-completion module to profile

[vexx32]

What You Are Seeing?

When installing Chocolatey, the choco installer code below automatically inserts the quoted code to a profile, including a comment that is essentially redundant and somewhat misleading:

choco/nuget/chocolatey/tools/chocolateysetup.psm1

Lines 613 to 620 in f6d6140

	$profileInstall = @'
	# Chocolatey profile
	$ChocolateyProfile = "$env:ChocolateyInstall\helpers\chocolateyProfile.psm1"
	if (Test-Path($ChocolateyProfile)) {
	Import-Module "$ChocolateyProfile"
	}
	'@

What is Expected?

Comment should mention that the module load enables Chocolatey tab completion, so users know what it's actually doing and don't remove it without knowing what they're disabling.

Quote from a user:

legit always thought "wtf is a chocolatey profile" and deleted it
(...)
I thought it was like
a profile that choco loads to do something
like on choco invoke

I would suggest the comment should read something along the lines of:

# This module contains the necessary code for tab-completions to function for `choco`.
# Be aware that if you are missing these lines from your profile, tab completion for choco
# will not function. See https://docs.chocolatey.org/en-us/troubleshooting#why-does-choco-intab-not-work-for-me
# for details.

We should create a shortlink to the doc to be used here instead of the long link, but you get the idea. 🙂

How Did You Get This To Happen? (Steps to Reproduce)

Run the Chocolatey install script.

Output Log

N/A