API pages:

- https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Entity%21...
- https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Config%21...

Both of these need to say what the return array is keyed by.

CommentFileSizeAuthor
#11 interdiff-2781819-5-11.txt755 byteschetan.s
#11 EntityListBuilder_load-2781819-11.patch723 byteschetan.s
#5 core-entitylistbuilderinterface-return-value-description-2781819-5.patch723 bytessubson
#2 core-entitylistbuilderinterface-return-value-description-2781819-2.patch715 bytessubson

Comments

joachim created an issue. See original summary.

subson’s picture

subson commented
StatusFileSize
new core-entitylistbuilderinterface-return-value-description-2781819-2.patch715 bytes

Trying a fix here.

subson’s picture

subson commented
Status: Active » Needs review
dawehner’s picture

dawehner
Primary language German
commented
Status: Needs review » Needs work

here is just a super quick review

+++ b/core/lib/Drupal/Core/Entity/EntityListBuilderInterface.php
@@ -22,7 +22,8 @@ public function getStorage();
-   *   An array of entities implementing \Drupal\Core\Entity\EntityInterface.
+   *   An array of entities implementing \Drupal\Core\Entity\EntityInterface indexed by their IDs.
+   *   Returns an empty array if no matching entities are found.
    */

This line exceeds 80 cars. Please break it up

subson’s picture

subson commented
Status: Needs work » Needs review
StatusFileSize
new core-entitylistbuilderinterface-return-value-description-2781819-5.patch723 bytes

Fixing the 80 char line limit.

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

Drupal 8.2.6 was released on February 1, 2017 and is the final full bugfix release for the Drupal 8.2.x series. Drupal 8.2.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.3.0 on April 5, 2017. (Drupal 8.3.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.3.x-dev branch from now on, and new development or disruptive changes should 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.

Munavijayalakshmi’s picture

Munavijayalakshmi commented
Assigned: Unassigned » Munavijayalakshmi
Status: Needs review » Reviewed & tested by the community
alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Needs work

Each line should break on 80 characters. But it should use up as much of the line as possible before breaking on a space. Please re-flow the comment.

shashikant_chauhan’s picture

shashikant_chauhan commented
Issue tags: +DrupalMumbaiCodeSprint16
chetan.s’s picture

chetan.s commented
Assigned: Munavijayalakshmi » chetan.s

I am working on it

chetan.s’s picture

chetan.s commented
Status: Needs work » Needs review
StatusFileSize
new EntityListBuilder_load-2781819-11.patch723 bytes
new interdiff-2781819-5-11.txt755 bytes

Adding updated patch.

joachim’s picture

joachim commented
Version: 8.3.x-dev » 8.4.x-dev
Status: Needs review » Reviewed & tested by the community

Looks good.

Confirming patch still applies to 8.4.x.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Title: EntityListBuilder::load() doesn't say what the return array is keyed by » EntityListBuilder::load() doesn't say that the return array is keyed by
Component: documentation » entity system
Issue tags: +Documentation

Looks great :)

joachim’s picture

joachim commented
Title: EntityListBuilder::load() doesn't say that the return array is keyed by » EntityListBuilder::load() doesn't say what the return array is keyed by

'that the return array is keyed by' doesn't make sense without an object...

/native english speaking pedantry ;)

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Fixed

Committed and pushed 003df9c to 8.4.x and 93bf800 to 8.3.x. Thanks!

Backported to 8.3.x as this is docs only change.

  • alexpott committed 003df9c on 8.4.x 
    Issue #2781819 by subson, chetan.s: EntityListBuilder::load() doesn't...

  • alexpott committed 93bf800 on 8.3.x 
    Issue #2781819 by subson, chetan.s: EntityListBuilder::load() doesn't...

Status: Fixed » Closed (fixed)

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