Fix SlotDiffRenderer documentation
authorLucas Werkmeister <lucas.werkmeister@wikimedia.de>
Thu, 14 Feb 2019 16:49:28 +0000 (17:49 +0100)
committerLucas Werkmeister <lucas.werkmeister@wikimedia.de>
Thu, 14 Feb 2019 16:52:43 +0000 (17:52 +0100)
I cannot find any trace of the getSlotDiffRendererClass method mentioned
in the old comment – even patch set 1 of I2f8a9dbebd, which introduced
the whole SlotDiffRenderer class, already had getSlotDiffRenderer and
getSlotDiffRendererInternal instead of getSlotDiffRendererClass in
ContentHandler.

Change-Id: I56595cedea3f82a328df64200dd9285d8526e67a

includes/diff/SlotDiffRenderer.php

index b30607f..969e0ba 100644 (file)
@@ -25,13 +25,13 @@ use Wikimedia\Assert\Assert;
 /**
  * Renders a diff for a single slot (that is, a diff between two content objects).
  *
- * Callers should obtain this class by invoking ContentHandler::getSlotDiffRendererClass
+ * Callers should obtain instances of this class by invoking ContentHandler::getSlotDiffRenderer
  * on the content handler of the new content object (ie. the one shown on the right side
  * of the diff), or of the old one if the new one does not exist.
  *
  * The default implementation just does a text diff on the native text representation.
  * Content handler extensions can subclass this to provide a more appropriate diff method by
- * overriding ContentHandler::getSlotDiffRendererClass. Other extensions that want to interfere
+ * overriding ContentHandler::getSlotDiffRendererInternal. Other extensions that want to interfere
  * with diff generation in some way can use the GetSlotDiffRenderer hook.
  *
  * @ingroup DifferenceEngine