comment documentations

Sources/Saving and Processing/Into.swift

@@ -43,7 +43,6 @@ public struct Into<T: NSManagedObject>: Hashable {
     
     /**
      Initializes an `Into` clause.
-     Sample Usage:
      ```
      let person = transaction.create(Into<MyPersonEntity>())
      ```
@@ -55,10 +54,10 @@ public struct Into<T: NSManagedObject>: Hashable {
     
     /**
      Initializes an `Into` clause with the specified entity type.
-     Sample Usage:
      ```
      let person = transaction.create(Into(MyPersonEntity))
      ```
+     
      - parameter entity: the `NSManagedObject` type to be created
      */
     public init(_ entity: T.Type) {
@@ -68,10 +67,10 @@ public struct Into<T: NSManagedObject>: Hashable {
     
     /**
      Initializes an `Into` clause with the specified entity class.
-     Sample Usage:
      ```
      let person = transaction.create(Into(MyPersonEntity))
      ```
+     
      - parameter entityClass: the `NSManagedObject` class type to be created
      */
     public init(_ entityClass: AnyClass) {
@@ -81,10 +80,10 @@ public struct Into<T: NSManagedObject>: Hashable {
     
     /**
      Initializes an `Into` clause with the specified configuration.
-     Sample Usage:
      ```
      let person = transaction.create(Into<MyPersonEntity>("Configuration1"))
      ```
+     
      - parameter configuration: the `NSPersistentStore` configuration name to associate the object to. This parameter is required if multiple configurations contain the created `NSManagedObject`'s entity type. Set to `nil` to use the default configuration.
      */
     public init(_ configuration: String?) {
@@ -94,10 +93,10 @@ public struct Into<T: NSManagedObject>: Hashable {
     
     /**
      Initializes an `Into` clause with the specified entity type and configuration.
-     Sample Usage:
      ```
      let person = transaction.create(Into(MyPersonEntity.self, "Configuration1"))
      ```
+     
      - parameter entity: the `NSManagedObject` type to be created
      - parameter configuration: the `NSPersistentStore` configuration name to associate the object to. This parameter is required if multiple configurations contain the created `NSManagedObject`'s entity type. Set to `nil` to use the default configuration.
      */
@@ -108,10 +107,10 @@ public struct Into<T: NSManagedObject>: Hashable {
     
     /**
      Initializes an `Into` clause with the specified entity class and configuration.
-     Sample Usage:
      ```
      let person = transaction.create(Into(MyPersonEntity.self, "Configuration1"))
      ```
+     
      - parameter entityClass: the `NSManagedObject` class type to be created
      - parameter configuration: the `NSPersistentStore` configuration name to associate the object to. This parameter is required if multiple configurations contain the created `NSManagedObject`'s entity type. Set to `nil` to use the default configuration.
      */

Sources/Saving and Processing/NSManagedObject+Transaction.swift

@@ -36,7 +36,7 @@ public extension NSManagedObject {
      
      When using an `UnsafeDataTransaction` and passing around a temporary object, you can use this property to execute fetches and updates to the transaction without having to pass around both the object and the transaction instances.
      
-     Note that the internal reference to the transaction is `weak`, and it is still the developer's responsibility to retain a strong reference to the `UnsafeDataTransaction`.
+     - Note: The internal reference to the transaction is `weak`, and it is still the developer's responsibility to retain a strong reference to the `UnsafeDataTransaction`.
      */
     @nonobjc
     public var unsafeDataTransaction: UnsafeDataTransaction? {

Sources/Saving and Processing/UnsafeDataTransaction.swift

@@ -118,7 +118,7 @@ public final class UnsafeDataTransaction: BaseDataTransaction {
     /**
      Returns the `NSManagedObjectContext` for this unsafe transaction. Use only for cases where external frameworks need an `NSManagedObjectContext` instance to work with.
      
-     Note that it is the developer's responsibility to ensure the following:
+     - Note: It is the developer's responsibility to ensure the following:
      - that the `UnsafeDataTransaction` that owns this context should be strongly referenced and prevented from being deallocated during the context's lifetime
      - that all saves will be done either through the `UnsafeDataTransaction`'s `commit(...)` method, or by calling `save()` manually on the context, its parent, and all other ancestor contexts if there are any.
      */