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

(#147) Improve help description for choco list command option --include-programs #3410

Merged
merged 1 commit into from
Apr 19, 2024

Conversation

hi2u
Copy link
Contributor

@hi2u hi2u commented Mar 26, 2024

Description Of Changes

  • Improved the help/documentation description for the flag: choco list --includeprograms
    • ❌ Old: Filters out apps Chocolatey has listed as packages and includes those in the list. Defaults to false.
    • ✔️ New: Also list applications not managed by Chocolatey. Defaults to false.

Motivation and Context

  • Old description was very confusing. Felt like I was having a brain aneurysm every time I read it. 😄

Testing

N/A

Change Types Made

  • Bug fix (non-breaking change).
  • Feature / Enhancement (non-breaking change).
  • Breaking change (fix or feature that could cause existing functionality to change).
  • Documentation changes.
  • PowerShell code changes.

Change Checklist

  • Requires a change to the documentation.
  • Documentation has been updated.
  • Tests to cover my changes, have been added.
  • All new and existing tests passed?
  • PowerShell code changes: PowerShell v2 compatibility checked?

Related Issue

Fixes #147

@CLAassistant
Copy link

CLAassistant commented Mar 26, 2024

CLA assistant check
All committers have signed the CLA.

@gep13 gep13 changed the title Improved help description for flag: "list --includeprograms" (#147) Improved help description for flag: "list --includeprograms" Apr 18, 2024
Copy link
Member

@gep13 gep13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hi2u thank you for taking the time to update this!

We agree that the current wording can be confusing, but I have made a slight change to your suggestion.

Are you in a position to update this, or would you prefer that I move forward with the change?

@gep13
Copy link
Member

gep13 commented Apr 18, 2024

@hi2u can I also ask that you update your commit message to include the referenced issue number, and include a description about the change that is being made.

Let me know if you aren't comfortable making this change, and I can help you through it, or I can make the necessary changes.

Thanks

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 gep13 force-pushed the hi2uincludeprograms-flag-desc branch from f0def8a to 244631e Compare April 19, 2024 12:07
Copy link
Member

@gep13 gep13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@gep13
Copy link
Member

gep13 commented Apr 19, 2024

@hi2u I have actually taken the liberty of making the suggested changes in this PR.

Thanks again for taking the time to address the original issue, really appreciate it!

@gep13 gep13 changed the title (#147) Improved help description for flag: "list --includeprograms" (#147) Improve help description for choco list command option --include-programs Apr 19, 2024
@gep13 gep13 merged commit 673b543 into chocolatey:develop Apr 19, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify what --include-programs option does, in the help output
3 participants