Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

Clarify what --include-programs option does, in the help output #147

Closed
Jaykul opened this issue Mar 4, 2015 · 4 comments · Fixed by #3410
Closed

Clarify what --include-programs option does, in the help output #147

Jaykul opened this issue Mar 4, 2015 · 4 comments · Fixed by #3410
Labels
5 - Released API Documentation
Milestone
2.3.0

Comments

@Jaykul
Copy link
Contributor

Jaykul commented Mar 4, 2015

-p, --includeprograms, --include-programs
IncludePrograms - Used in conjuction with LocalOnly, filters out apps
chocolatey has listed as packages and includes those in the list.
Defaults to false.

The phrase filters out apps is confusing.
So is the phrase apps chocolatey has listed as packages

Does this hide things?
Does this SHOW apps, or does it SHOW packages that are NOT apps?

Perhaps what you mean is:

IncludePrograms - When LocalOnly is specified, chocolatey does not 
    include packages that are listed as apps, set this to show them in the list.
   Defaults to false.

But I really can't tell for sure.
@ferventcoder
Copy link
Member

Run it, it makes more sense when you do.

Basically it compares the list you have installed with ARP (add remove programs), returns results from local only and then also returns results from ARP that are not part of the already returned results from local only pacakges

@Jaykul
Copy link
Contributor Author

Jaykul commented Mar 5, 2015

So maybe what it should say is ...

IncludePrograms - When LocalOnly is specified, list packages
managed by chocolatey, and then also list all programs
in add-remove programs which are not managed by chocolatey.

Or leaving aside the "in add-remove programs" it could just say:

IncludePrograms - When LocalOnly is specified, list packages
managed by chocolatey, and then also list all installed programs
which are not managed by chocolatey.

@ferventcoder
Copy link
Member

I like. :)

@ferventcoder ferventcoder modified the milestones: 0.10.9, 0.10.10 Aug 27, 2017
@ferventcoder ferventcoder changed the title choco list --includeprograms help is confusing [API] choco list --includeprograms help is confusing Aug 29, 2017
@ferventcoder ferventcoder modified the milestones: 0.10.10, 0.10.12 Mar 27, 2018
@ferventcoder ferventcoder modified the milestones: 0.10.12, 0.10.13 May 3, 2018
@ferventcoder ferventcoder modified the milestones: 0.10.13, 0.10.14, 0.10.15 Mar 9, 2019
@ferventcoder ferventcoder modified the milestones: 0.10.15, 0.10.16 Apr 1, 2019
@gep13 gep13 modified the milestones: 0.10.16, 0.10.17 May 31, 2019
@ferventcoder ferventcoder modified the milestones: 0.10.17, 0.10.18 Jan 14, 2020
@ferventcoder ferventcoder modified the milestones: 0.10.18, 0.10.x Apr 14, 2021
@pauby pauby changed the title [API] choco list --includeprograms help is confusing The help for choco list --includeprograms is unclear Dec 19, 2023
@hi2u hi2u mentioned this issue Mar 26, 2024
Merged
10 tasks
@gep13 gep13 modified the milestones: Future, 2.3.0 Apr 18, 2024
gep13 pushed a commit to hi2u/choco that referenced this issue Apr 19, 2024
@hi2u @gep13
(chocolatey#147) Improve help description for command option
244631e 
The help description for the IncludePrograms option on the list command
was confusing, as it didn't make clear what actually happens when you
use the --includeprograms option.

This commit attempts to address this by calling out that the output
changes when using this option to include the additional pieces of
software which appear in add/remove programs, which aren't already
managed by Chocolatey CLI.
gep13 added a commit that referenced this issue Apr 19, 2024
@gep13
Merge pull request #3410 from hi2u/hi2uincludeprograms-flag-desc
673b543 
(#147)  Improve help description for `choco list` command option `--include-programs`
@gep13 gep13 added 4 - Done and removed 3 - Review labels Apr 19, 2024
@pauby pauby changed the title The help for choco list --includeprograms is unclear Clarify what --include-programs option does in the help May 28, 2024
@pauby pauby changed the title Clarify what --include-programs option does in the help Clarify what --include-programs option does, in the help output May 28, 2024
@choco-bot
Copy link

🎉 This issue has been resolved in version 2.3.0 🎉

The release is available on:

Your GitReleaseManager bot 📦 🚀

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
5 - Released API Documentation
Projects
None yet
Milestone
2.3.0
Development

Successfully merging a pull request may close this issue.

(#147) Improve help description for choco list command option --include-programs hi2u/choco
4 participants
@ferventcoder @Jaykul @gep13 @choco-bot