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

(maint) Improve log message #1852

Merged
merged 1 commit into from
Apr 16, 2021
Merged

(maint) Improve log message #1852

merged 1 commit into from
Apr 16, 2021

Conversation

Mauville
Copy link
Contributor

The log message when trying to downgrade a program
shows a variety of switches, --force, --allow-downgrade
One of these is formatted as prose, side by side
Changed to reflect proper switch syntax.

@@ -464,7 +464,7 @@ public void install_noop(ChocolateyConfiguration config, Action<PackageResult> c

if (installedPackage != null && version != null && version < installedPackage.Version && !config.AllowMultipleVersions && !config.AllowDowngrade)
{
string logMessage = "A newer version of {0} (v{1}) is already installed.{2} Use --allow-downgrade or --force to attempt to install older versions, or use side by side to allow multiple versions.".format_with(installedPackage.Id, installedPackage.Version, Environment.NewLine);
string logMessage = "A newer version of {0} (v{1}) is already installed.{2} Use --allow-downgrade or --force to attempt to install older versions, or use --sidebyside to allow multiple versions.".format_with(installedPackage.Id, installedPackage.Version, Environment.NewLine);
Copy link
Member

Choose a reason for hiding this comment

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

While this looks great, can we get it as --side-by-side or --allow-multiple-versions?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not following.
As in:
install older versions, or use --side-by-side to --allow-multiple-versions.".

Because I'm not sure if that last one is a switch

Copy link
Member

Choose a reason for hiding this comment

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

@Mauville he is talking about changing --sidebyside to either --side-by-side or to --allow-multiple-versions.

For instance:
or use --side-by-side to allow multiple versions
or
or use --allow-multiple-versions to allow multiple versions

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok. I feel like --side-by-side would be a better alternative in this case because syntactically speaking, it makes more sense to pass a flag like

choco install anki --side-by-side

than

choco install anki --allow-multiple-versions

Copy link
Member

@ferventcoder ferventcoder left a comment

Choose a reason for hiding this comment

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

Hi @Mauville! Thanks for providing that to improve our messaging. I have one small request on the way that is formatted. If you need any help on that, let us know. If you want us to go ahead and fix it for you as we pull it in, we can do that as well.

@Mauville
Copy link
Contributor Author

Mauville commented Jan 3, 2020

If you want us to go ahead and fix it for you as we pull it in, we can do that as well.

Thanks. I would gladly appreciate it.

@CLAassistant
Copy link

CLAassistant commented Jun 8, 2020

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
8 out of 9 committers have signed the CLA.

✅ DdOtzen
✅ gep13
✅ peteraritchie
✅ GankousKhan
✅ gliptak
✅ skel35
✅ jetersen
✅ TheCakeIsNaOH
❌ Mauville
You have signed the CLA already but the status is still pending? Let us recheck it.

The log message when trying to downgrade a program
shows a variety of switches, --force, --allow-downgrade
One of these is formatted as prose, side by side
Changed to reflect proper switch syntax.
@gep13 gep13 changed the base branch from master to stable April 16, 2021 15:17
@gep13 gep13 changed the title (maint) Correct a log message (maint) Improve log message Apr 16, 2021
@gep13
Copy link
Member

gep13 commented Apr 16, 2021

@Mauville thank you very much for taking the time to raise this PR. I have taken the liberty of making the suggested changes, and I have pushed these changes to your branch.

Since this is a minor documentation change, and not changing any of the functional code, signing of the CLA is not required.

Once the CI builds are completed, I will get this change merged in.

@gep13 gep13 merged commit a3e6f56 into chocolatey:stable Apr 16, 2021
@gep13
Copy link
Member

gep13 commented Apr 16, 2021

@Mauville thanks again for your contribution here!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants