Clarify documentation on CustomIncludes [MA-150]

art-institute-of-chicago · Dec 4, 2023 · 50cd21b · 50cd21b
1 parent e703c39
commit 50cd21b
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/app/Models/Transformers/CustomIncludes.php b/app/Models/Transformers/CustomIncludes.php
@@ -11,7 +11,7 @@
  *
  * Usage:
  *  protected $customIncludes = [
- *      'some_data' => DifferentSerializer::class,
+ *      'related_models' => DifferentSerializer::class,
  *  ];
  *
  *  public function transform($model)
@@ -21,9 +21,9 @@
  *      ]);
  *  }
  *
- *  protected includeSomeData($models)
+ *  protected includeRelatedModels($models)
  *  {
- *      return $this->collection($models, new ModelTransformer(), 'optional_key');
+ *      return $this->collection($models->related_models, new ModelTransformer(), 'optional_key');
  *  }
  */
 trait CustomIncludes