Skip to content

Commit 709b0a9

Browse files
committed
Add a comment to better explain GoalState.IsAchieved
1 parent a30dc6b commit 709b0a9

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/LibraryManager.Contracts/LibraryInstallationGoalState.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ public LibraryInstallationGoalState(ILibraryInstallationState installationState,
3333
/// <summary>
3434
/// Returns whether the goal is in an achieved state - that is, all files are up to date.
3535
/// </summary>
36+
/// <remarks>
37+
/// This is intended to serve as a fast check compared to restoring the files.
38+
/// If there isn't a faster way to verify that a file is up to date, this method should
39+
/// return false to indicate that a restore can't be skipped.
40+
/// </remarks>
3641
public bool IsAchieved()
3742
{
3843
foreach (KeyValuePair<string, string> kvp in InstalledFiles)

0 commit comments

Comments
 (0)