Skip to content

Commit

Permalink
(#2656) Add information to class
Browse files Browse the repository at this point in the history
So that when we look back on this, we will remember why these classes
were re-instated.
  • Loading branch information
gep13 committed Mar 23, 2022
1 parent 02f9cb6 commit a973831
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ namespace chocolatey.infrastructure.app.commands
using configuration;
using services;

/// <summary>
/// This class is provided to allow backwards compatibility for users of older Chocolatey Licensed Extension versions,
/// for example, those using a perpetual license. In the release of Chocolatey CLI v1.0.0 and Chocolatey Licensed
/// Extension v4.0.0, these classes were removed, as it was thought that anyone using v1.0.0 would upgrade to v4.0.0
/// as well, however, this is not always possible.
///
/// Therefore, this skeleton class, with no actual implementations, have been re-added to allow usage of v1.0.1 of
/// Chocolatey, along with say v3.2.0, or v2.2.1, of Chocolatey Licensed Extension. It is expected at some point that
/// this class can/will be removed, perhaps in v2.0.0, but for now, they will remain in place.
/// </summary>
public class ChocolateyUpdateCommand : ChocolateyUpgradeCommand
{
public ChocolateyUpdateCommand(IChocolateyPackageService packageService) : base(packageService)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ namespace chocolatey.infrastructure.app.commands
using configuration;
using services;

/// <summary>
/// This class is provided to allow backwards compatibility for users of older Chocolatey Licensed Extension versions,
/// for example, those using a perpetual license. In the release of Chocolatey CLI v1.0.0 and Chocolatey Licensed
/// Extension v4.0.0, these classes were removed, as it was thought that anyone using v1.0.0 would upgrade to v4.0.0
/// as well, however, this is not always possible.
///
/// Therefore, this skeleton class, with no actual implementations, have been re-added to allow usage of v1.0.1 of
/// Chocolatey, along with say v3.2.0, or v2.2.1, of Chocolatey Licensed Extension. It is expected at some point that
/// this class can/will be removed, perhaps in v2.0.0, but for now, they will remain in place.
/// </summary>
public class ChocolateyVersionCommand : ChocolateyUpgradeCommand
{
public ChocolateyVersionCommand(IChocolateyPackageService packageService) : base(packageService)
Expand Down

0 comments on commit a973831

Please sign in to comment.