Skip to content

Commit

Permalink
Add a comment to better explain GoalState.IsAchieved
Browse files Browse the repository at this point in the history
  • Loading branch information
jimmylewis committed May 18, 2024
1 parent cd23be1 commit f65d34b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/LibraryManager.Contracts/LibraryInstallationGoalState.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ public LibraryInstallationGoalState(ILibraryInstallationState installationState,
/// <summary>
/// Returns whether the goal is in an achieved state - that is, all files are up to date.
/// </summary>
/// <remarks>
/// This is intended to serve as a fast check compared to restoring the files.
/// If there isn't a faster way to verify that a file is up to date, this method should
/// return false to indicate that a restore can't be skipped.
/// </remarks>
public bool IsAchieved()
{
foreach (KeyValuePair<string, string> kvp in InstalledFiles)
Expand Down

0 comments on commit f65d34b

Please sign in to comment.