Fix typos in README and documentation

gaoyinhui · Aug 8, 2018 · 468a780 · 468a780
1 parent 0f8860f
commit 468a780
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -312,7 +312,7 @@ storage.removeExpiredObjects()
 [Storage](#storage) allows you to observe changes in the cache layer, both on
 a store and a key levels. The API lets you pass any object as an observer,
 while also passing an observation closure. The observation closure will be
-removed automatically when the weekly captured observer has been deallocated.
+removed automatically when the weakly captured observer has been deallocated.
 
 ## Storage observations
 

diff --git a/Source/Shared/Storage/KeyObservationRegistry.swift b/Source/Shared/Storage/KeyObservationRegistry.swift
@@ -6,8 +6,8 @@ public protocol KeyObservationRegistry {
 
   /**
    Registers observation closure which will be removed automatically
-   when the weekly captured observer has been deallocated.
-   - Parameter observer: Any object that helps to determine if the observation is still valid
+   when the weakly captured observer has been deallocated.
+   - Parameter observer: Any object that helps determine if the observation is still valid
    - Parameter key: Unique key to identify the object in the cache
    - Parameter closure: Observation closure
    - Returns: Token used to cancel the observation and remove the observation closure
@@ -19,7 +19,10 @@ public protocol KeyObservationRegistry {
     closure: @escaping (O, S, KeyChange<S.T>) -> Void
   ) -> ObservationToken
 
-  /// Removes observer by the given key.
+  /**
+   Removes observer by the given key.
+   - Parameter key: Unique key to identify the object in the cache
+   */
   func removeObserver(forKey key: String)
 
   /// Removes all registered key observers

diff --git a/Source/Shared/Storage/StorageObservationRegistry.swift b/Source/Shared/Storage/StorageObservationRegistry.swift
@@ -6,8 +6,8 @@ public protocol StorageObservationRegistry {
 
   /**
    Registers observation closure which will be removed automatically
-   when the weekly captured observer has been deallocated.
-   - Parameter observer: Any object that helps to determine if the observation is still valid
+   when the weakly captured observer has been deallocated.
+   - Parameter observer: Any object that helps determine if the observation is still valid
    - Parameter closure: Observation closure
    - Returns: Token used to cancel the observation and remove the observation closure
    */