Update docs for InstallUpdateFailure

NetSparkleUpdater · Jan 8, 2025 · f38cd70 · f38cd70
1 parent e1a818b
commit f38cd70
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/NetSparkle/NetSparkleDelegates.cs b/src/NetSparkle/NetSparkleDelegates.cs
@@ -140,6 +140,7 @@ namespace NetSparkleUpdater
     /// </summary>
     /// <param name="failureReason"><seealso cref="InstallUpdateFailureReason"/> reason for failure</param>
     /// <param name="installPath">Path for installer (can be null)</param>
-    /// <returns></returns>
+    /// <returns>Result is unused; return whatever you like. This will be changed in a future version
+    /// to `void`.</returns>
     public delegate bool InstallUpdateFailure(InstallUpdateFailureReason failureReason, string? installPath);
 }