Doc improvments

Author: mattmassicotte

README.md

@@ -19,7 +19,7 @@ dependencies: [
 
 **ContainedDocumentController**
 
-An `NSDocumentController` subclass that manages the `NSDocument` lifecycle and manages the relationship to your containers. To use it, you must override the three container-document association methods. Restorable state is supported, but is optional.
+An `NSDocumentController` subclass that manages the `NSDocument` life-cycle and relationship to your containers. To use it, you must override the three container-document association methods. Restorable state is supported, but is optional.
 
 ```swift
 open func associateDocument(_ document: NSDocument, to container: Container)
@@ -31,6 +31,8 @@ open func restoreState(with coder: NSCoder, for document: NSDocument)
 // ...
 ```
 
+Also, don't forget that an `NSDocumentController` is global to your AppKit process. You must instantiate your subclass as soon as possible to ensure it is being used.
+
 **ContainedDocument**
 
 This is an `NSDocument` subclass that makes it possible to support document duplication and window restoration.

Sources/ContainedDocument/ContainedDocumentController.swift

@@ -55,22 +55,26 @@ open class ContainedDocumentController<Container>: BaseDocumentController {
 
     /// Called when a document is being associated to a container
     ///
-    /// The default implemenation does nothing. Subclasses can use this to establish
+    /// The default implementation does nothing. Subclasses can use this to establish
     /// a relationship, if it is appropriate for the document/container type.
     open func associateDocument(_ document: NSDocument, to container: Container) {
+		print("warning: associateDocument not implemented in subclass")
     }
 
     /// Called when a document is being removed.
     ///
-    /// The default implemenation does nothing. Subclasses can use this to tear down
+    /// The default implementation does nothing. Subclasses can use this to tear down
     /// a relationship, if it is appropriate for the document/container type.
     open func disassociateDocument(_ document: NSDocument) {
+		print("warning: disassociateDocument not implemented in subclass")
     }
 
     /// Used to query the current container of a document.
     ///
-    /// The default implemenation returns nil.
+    /// The default implementation returns nil.
     open func documentContainer(for document: NSDocument) -> Container? {
+		print("warning: documentContainer not implemented in subclass")
+
         return nil
     }