Problem/Motivation

The API documentation for \Drupal\Core\Cache\ChainedFastBackendFactory is literally just:

Defines the chained fast cache backend factory.

This leaves many questions unanswered, but nowhere on that page is a link to ChainedFastBackend, which might answer them.

Proposed resolution

Add a @see reference to the factory class, referencing the backend class.

Remaining tasks

* Submit a patch
* Get patch approval

User interface changes

None.

API changes

None.

Data model changes

None.

CommentFileSizeAuthor
#2 improve_documentation-2844874-2.patch486 bytesjp.stacey
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

jp.stacey created an issue. See original summary.

jp.stacey’s picture

jp.stacey CreditAttribution: jp.stacey at Magnetic Phield commented
Status: Needs work » Needs review
FileSize
improve_documentation-2844874-2.patch486 bytes

Patch attached for review and discussion.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

LoMo’s picture

LoMo CreditAttribution: LoMo as a volunteer commented
Version: 8.4.x-dev » 8.3.x-dev
Status: Needs review » Reviewed & tested by the community

Seems like a pretty straightforward fix. The patch applies and does what it should. I've looked at the relationship and agree that we should have this @see reference to the ChainedFastBackend in the ChainedFastBackendFactory.php (if not more, but at least this is a good addition).

As this improvement is totally non-disruptive, it can (and really should) be "backported" to 8.3.x-dev, so I've reverted the automatically-added 8.4.x-dev version change.

  • catch committed e1e1e6f on 8.4.x 
    Issue #2844874 by jp.stacey: Improve documentation for...

  • catch committed 0b22fd4 on 8.3.x 
    Issue #2844874 by jp.stacey: Improve documentation for...
catch’s picture

catch
he/him
Primary language English
CreditAttribution: catch at Third and Grove commented
Status: Reviewed & tested by the community » Fixed

Committed/pushed to 8.4.x and cherry-picked to 8.3.x. Thanks!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.