updated documentation (in progress)

CoreStore/Convenience Helpers/NSManagedObject+Convenience.swift

@@ -31,6 +31,12 @@ import CoreData
 
 public extension NSManagedObject {
     
+    /**
+    Provides a convenience wrapper for accessing `primitiveValueForKey(...)` with proper calls to `willAccessValueForKey(...)` and `didAccessValueForKey(...)`. This is useful when implementing accessor methods for transient attributes.
+    
+    - parameter KVCKey: the KVC key
+    - returns: the primitive value for the KVC key
+    */
     public func accessValueForKVCKey(KVCKey: KeyPath) -> AnyObject? {
         
         self.willAccessValueForKey(KVCKey)
@@ -40,6 +46,12 @@ public extension NSManagedObject {
         return primitiveValue
     }
     
+    /**
+    Provides a convenience wrapper for setting `setPrimitiveValue(...)` with proper calls to `willChangeValueForKey(...)` and `didChangeValueForKey(...)`. This is useful when implementing mutator methods for transient attributes.
+    
+    - parameter value: the value to set the KVC key with
+    - parameter KVCKey: the KVC key
+    */
     public func setValue(value: AnyObject?, forKVCKey KVCKey: KeyPath) {
         
         self.willChangeValueForKey(KVCKey)

CoreStore/Convenience Helpers/NSProgress+Convenience.swift

@@ -33,6 +33,10 @@ public extension NSProgress {
     
     // MARK: Public
     
+    /**
+    Sets a closure that the `NSProgress` calls whenever its `fractionCompleted` changes. You can use this instead of setting up KVO.
+    - parameter closure: the closure to execute on progress change
+    */
     public func setProgressHandler(closure: ((progress: NSProgress) -> Void)?) {
         
         self.progressObserver.progressHandler = closure

CoreStore/Internal/NSManagedObjectContext+Querying.swift

@@ -251,6 +251,7 @@ internal extension NSManagedObjectContext {
         fetchRequest.fetchLimit = 0
         fetchRequest.resultType = .ManagedObjectResultType
         fetchRequest.returnsObjectsAsFaults = true
+        fetchRequest.includesPropertyValues = false
         
         for clause in deleteClauses {
             

CoreStore/Migrating/MigrationChain.swift

@@ -32,7 +32,7 @@ import CoreData
 /**
 A `MigrationChain` indicates the sequence of model versions to be used as the order for incremental migration. This is typically passed to the `DataStack` initializer and will be applied to all stores added to the `DataStack` with `addSQLiteStore(...)` and its variants.
 
-Initializing with empty values (either `nil`, `[]`, or `[:]`) signifies to use the .xcdatamodel's current version as the final version, and to disable incremental migrations:
+Initializing with empty values (either `nil`, `[]`, or `[:]`) instructs the `DataStack` to use the .xcdatamodel's current version as the final version, and to disable incremental migrations:
 
     let dataStack = DataStack(migrationChain: nil)
 
@@ -151,8 +151,7 @@ public struct MigrationChain: NilLiteralConvertible, StringLiteralConvertible, D
         self.versionTree = versionTree
         self.rootVersions = Set(versionTree.keys).subtract(versionTree.values)
         self.leafVersions = leafVersions
-        self.valid = valid
-            && Set(versionTree.keys).union(versionTree.values).filter { isVersionAmbiguous($0) }.count <= 0
+        self.valid = valid && Set(versionTree.keys).union(versionTree.values).filter { isVersionAmbiguous($0) }.count <= 0
     }
     
     

CoreStore/Migrating/MigrationResult.swift

@@ -137,12 +137,12 @@ public enum MigrationResult {
     // MARK: Public
     
     /**
-    `MigrationResult.Success` indicates that the `commit()` for the transaction succeeded, either because the save succeeded or because there were no changes to save. The associated value `hasChanges` indicates if there were saved changes or not.
+    `MigrationResult.Success` indicates either the migration succeeded, or there were no migrations needed. The associated value is an array of `MigrationType`s reflecting the migration steps completed.
     */
     case Success([MigrationType])
     
     /**
-    `SaveResult.Failure` indicates that the `commit()` for the transaction failed. The associated object for this value is the related `NSError` instance.
+    `SaveResult.Failure` indicates that the migration failed. The associated object for this value is the related `NSError` instance.
     */
     case Failure(NSError)
     
@@ -166,9 +166,7 @@ public enum MigrationResult {
     
     internal init(_ errorCode: CoreStoreErrorCode, userInfo: [NSObject: AnyObject]?) {
         
-        self.init(NSError(
-            coreStoreErrorCode: errorCode,
-            userInfo: userInfo))
+        self.init(NSError(coreStoreErrorCode: errorCode, userInfo: userInfo))
     }
 }