PRR fixes

Author: Chris Cho

docs/eloquent-models/model-class.txt

@@ -11,6 +11,12 @@ Eloquent Model Class
 .. meta::
    :keywords: php framework, odm, code example, authentication, laravel
 
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
 Overview
 --------
 
@@ -25,8 +31,8 @@ to {+odm-short+} models:
 - :ref:`laravel-authenticatable-model` shows how to set MongoDB as the
   authentication user provider.
 - :ref:`laravel-model-customize` explains several model class customizations
-- :ref:`laravel-model-pruning` shows how to remove models that you no longer
-  need periodically.
+- :ref:`laravel-model-pruning` shows how to periodically remove models that
+  you no longer need.
 
 .. _laravel-model-define:
 
@@ -247,8 +253,8 @@ in the Laravel docs.
 Specify Pruning Behavior
 ------------------------
 
-Eloquent lets you specify criteria to delete model data that you no longer
-need automatically.  When you schedule or run the ``model:prune`` command,
+Eloquent lets you specify criteria to periodically delete model data that you
+no longer need.  When you schedule or run the ``model:prune`` command,
 Laravel calls the ``prunable()`` method on all models that import the
 ``Prunable`` and ``MassPrunable`` traits to match the models for deletion.
 

docs/includes/eloquent-models/AuthenticatableUser.php

@@ -2,6 +2,8 @@
 
 namespace App\Models;
 
+use MongoDB\Laravel\Auth\User as Authenticatable;
+
 class User extends Authenticatable
 {
 }

docs/includes/eloquent-models/PlanetMassAssignment.php

@@ -7,7 +7,7 @@
 class Planet extends Model
 {
     /**
-     * The attributes that are mass assignable.
+     * The mass assignable attributes.
      *
      * @var array
      */

docs/includes/eloquent-models/PlanetMassPrune.php

@@ -11,7 +11,8 @@ class Planet extends Model
 
     public function prunable()
     {
-        // matches models in which the solar_system field contains a null value
+        // matches models in which the gravitational_force field contains
+        // a value greater than 0.5
         return static::where('gravitational_force', '>', 0.5);
     }
 }

docs/includes/eloquent-models/PlanetPrune.php

@@ -17,6 +17,7 @@ public function prunable()
 
     protected function pruning()
     {
-        // delete photo assets of this model
+        // Cleanup cations such as deleting photo assets of this
+        // model or printing the Planet 'name' attribute to a log file
     }
 }