Fix doc comment describing when the remove function is called

square · Jul 25, 2023 · 7242f1f · 7242f1f
1 parent ae66e1e
commit 7242f1f
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/ViewEnvironmentUI/Sources/ViewEnvironmentPropagating.swift b/ViewEnvironmentUI/Sources/ViewEnvironmentPropagating.swift
@@ -377,7 +377,8 @@ public typealias ViewEnvironmentUpdateObservation = (ViewEnvironment) -> Void
 public final class ViewEnvironmentUpdateObservationLifetime {
     /// Removes the observation.
     ///
-    /// This is called in `deinit`.
+    /// The observation is removed when the lifetime is de-initialized if this function was not
+    /// called before then.
     ///
     public func remove() {
         guard let onRemove else {
@@ -482,7 +483,8 @@ public typealias ViewEnvironmentCustomization = (inout ViewEnvironment) -> Void
 public final class ViewEnvironmentCustomizationLifetime {
     /// Removes the observation.
     ///
-    /// This is called in `deinit`.
+    /// The customization is removed when the lifetime is de-initialized if this function was not
+    /// called before then.
     ///
     public func remove() {
         onRemove()