Merge pull request #35 from seandenigris/doc_magritte-parsers

[Doc]: Magritte Two-Stage Importer - Class and method comments

repository/Neo-CSV-Magritte/MACSVTwoStageImporter.class.st

@@ -1,3 +1,10 @@
+"
+Sometimes, you just can't fully create your domain objects from CSV in one pass. For example:
+- Multiple rows combine into one object (`inject:into:` can be helpful here)
+- Multiple cells combine into one object field
+
+To handle such a case, subclass me and, at minimum, override `#convertToDomainObjects:`. See its comment for more info. Implementations of that method often utilize my `#initializeDomainObject:fromRecord:` helper method.
+"
 Class {
 	#name : #MACSVTwoStageImporter,
 	#superclass : #MACSVImporter,
@@ -20,6 +27,9 @@ MACSVTwoStageImporter >> configureReaderFor: aStream [
 
 { #category : #accessing }
 MACSVTwoStageImporter >> convertToDomainObjects: aCollectionOfDictionaries [
+	"aCollectionOfDictionaries - the result of a naive processing of CSV
+	Return - a collection of domain objects"
+
 	^ aCollectionOfDictionaries
 		inject: OrderedCollection new 
 		into: [ :col :rowDict |