Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Terminology improvements in choco.exe help output #1861

Closed
bcurran3 opened this issue Jun 26, 2019 · 1 comment
Closed

Terminology improvements in choco.exe help output #1861

bcurran3 opened this issue Jun 26, 2019 · 1 comment

Comments

@bcurran3
Copy link

The following are produced by choco.exe, thus this isn't in documentation issues. All referenced output is via Chocolatey v0.10.15

Commands
 * install - installs packages from various sources

ENHANCEMENT: "various sources" just seems misleading. What percentage of free or commercial users actually install packages from multiple sources? I'd guess most use one source or two sources; i.e. internal repository and possibly the community repo as a 2nd. Maybe "installs packages" would be be better, simpler, cover the broader base.

* outdated - retrieves packages that are outdated. Similar to upgrade all --noop

BUG: It doesn't retrieve packages, the command retrieves package information about outdated packages/lists

* pack - packages up a nuspec to a compiled nupkg

ENHANCEMENT: Could say "packages nuspec, scripts, and other Chocolatey package resources into a nupkg file

* push - pushes a compiled nupkg

ENHANCEMENT: Could say "pushes a compiled nupkg to a repository (or maybe source)"

* new - generates files necessary for a chocolatey package from a template

ENHANCEMENT: new actually creates multiple template files as a package template. It could say "creates template files for creating a new Chocolatey package"

 * unpackself - have chocolatey set itself up

SUBJECTIVE: Might be be better stated as "Re-installs Chocolatey" or "Re-installs Chocolatey base files"

@ferventcoder
Copy link
Member

I like it - Would you like to try your hand at a pull request on this one?

@ferventcoder ferventcoder added this to the 0.10.16 milestone Jul 2, 2019
mprasanth added a commit to mprasanth/choco that referenced this issue Jul 20, 2019
gep13 pushed a commit to mprasanth/choco that referenced this issue Apr 18, 2021
Some suggestions were made on how the help documentation for various
commands could be improved, making them less subjective.
gep13 pushed a commit to mprasanth/choco that referenced this issue Apr 18, 2021
Some suggestions were made on how the help documentation for various
commands could be improved, making them less subjective.
@gep13 gep13 changed the title ENHANCEMENTS & BUG - terminology improvements in choco.exe help output Terminology improvements in choco.exe help output Apr 18, 2021
gep13 pushed a commit to mprasanth/choco that referenced this issue Apr 18, 2021
Some suggestions were made on how the help documentation for various
commands could be improved, making them less subjective.
gep13 added a commit that referenced this issue Apr 18, 2021
(#1861) This improves the terminology in choco.exe help output
@gep13 gep13 closed this as completed Apr 18, 2021
gep13 added a commit that referenced this issue Apr 19, 2021
* stable:
  (#1861) Improves terminology in help documentation
  (#1998) Add authorization header to Get-WebFile
  (maint) Repalce RawGit with raw.githack.com CDN
  (#1899) Remove unused variables
  (GH-1060) Add BeforeInstall parameter to Install-ChocolateyPackage.ps1
  (maint) Improve log message
  (GH-2092) Take all registry keys into account
  (GH-1364) Template create .nuspec encoded without BOM
  (#1866) Limit pending package removal to top level
  (GH-2203) Get-ChocolateyUnzip add unzipLocation alias
  (GH-1889) Fix: Removal of ApiKey broken
  (#2114) Remove unused variable
  (GH-2048) update deprecation note to outdated
  (maint) Spelling and grammar fixes
  (maint) Replace tabs with spaces
  (#2078) Skip importing Chocolatey GUI Extension
  (#2227) Use latest Mono and Ubuntu on Travis
steviecoaster added a commit to steviecoaster/choco that referenced this issue May 11, 2021
…GH2112

* 'GH2112' of https://github.com/steviecoaster/choco:
  (chocolatey#2112) Add msp support to Install helper
  (maint) Switch to using a Regex match
  (maint) Change formatting
  (maint) Remove use of PowerShell aliases
  (maint) Replace " with '
  (chocolatey#2044) Fix for changing $env:Temp
  (chocolatey#2259) Switched to versioned NuGet.Core
  (chocolatey#2111) Deep copy config
  (chocolatey#2244) Add Mac build into main workflow
  (chocolatey#2238) Mono build don't hardcode xbuild path
  (maint) Fix artifact paths on AppVeyor
  (chocolatey#2244) Fix syntax for running on Windows
  (chocolatey#2244) Initial workflow for Windows and Ubuntu
  (doc) Remove Mono instructions for other distributions
  (doc) Add Ubuntu 20.04 mono install instructions
  (chocolatey#2227) Bump Mono version in Dockerfile and README
  (chocolatey#2236) Mono test work with merged usr systems
  (chocolatey#2190) Clarify help for SpecificFolder parameter
  (chocolatey#1962) Use different message on error
  (chocolatey#1861) Improves terminology in help documentation
  (chocolatey#1998) Add authorization header to Get-WebFile
  (maint) Repalce RawGit with raw.githack.com CDN
  (chocolatey#1899) Remove unused variables
  (chocolateyGH-1060) Add BeforeInstall parameter to Install-ChocolateyPackage.ps1
  (maint) Improve log message
  (chocolateyGH-2092) Take all registry keys into account
  (chocolateyGH-1364) Template create .nuspec encoded without BOM
  (chocolatey#1866) Limit pending package removal to top level
  (chocolateyGH-2203) Get-ChocolateyUnzip add unzipLocation alias
  (chocolateyGH-1889) Fix: Removal of ApiKey broken
  (chocolatey#2114) Remove unused variable
  (chocolateyGH-2048) update deprecation note to outdated
  (maint) Spelling and grammar fixes
  (maint) Replace tabs with spaces
  (chocolatey#2078) Skip importing Chocolatey GUI Extension
  (chocolatey#2227) Use latest Mono and Ubuntu on Travis
  (chocolatey#2205) Remove mention of private repository
  (chocolatey#2205) Update remaining URLs to new location
  (maint) Remove unnecessary whitespace
  (chocolatey#2231) Change default repository URL
  (maint) Remove unnecessary whitespace
  (chocolatey#2205) Update all chocolatey.org/docs URLs
  (maint) Remove unnecessary whitespace
  (chocolatey#2205) Update automatic-packages docs links
  (doc) Update to prefer # rather than GH-
  (maint) Fix replacement
  (maint) Revert change to earlier commit
  (maint) Fix spelling mistake
  (maint) Fix spelling mistake
  (doc) Update script to Statiq format
  (maint) Add missing backtick in example
  (maint) Added explicit link to new function name
  (maint) Fix spelling mistake
  (maint) Fix spelling mistake
  (maint) Fix spelling mistake
  (maint) Fix spelling mistake
  (maint) Fix spelling mistake
  (maint) Fix spelling mistake
  (maint) Remove generated docs files
  (maint) Add docs/generated folder to ignore list
  (chocolateyGH-2105) Update link to Chocolatey workshop
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants