Closed (fixed)
Project:
Drupal core
Version:
8.0.x-dev
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
20 Jun 2011 at 19:47 UTC
Updated:
29 Jul 2014 at 19:42 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
droplet commentedYou right, can you send us a patch
Comment #2
jhodgdonIt looks like $entity it only accepts a single entity rather than an array also -- it's not just the arg name that is wrong, but also the param description.
Same problem with the $instance parameter.
And the description says "field values" - perhaps that should be reworded to say it's only for one field on one entity instance?
Comment #3
jhodgdonProbably a good project for a novice doc contributor
Comment #4
James_Stallings commentedComment #5
James_Stallings commentedComment #6
James_Stallings commentedWhile scanning through field.default.inc, I noticed a lot of documentation issues. I'll go ahead and file these.
Comment #7
droplet commented$instance is an array
$entity is an object
can we docs it ?
@James_Stallings,
can you fix it in same issue if there are similar errors.
Comment #8
James_Stallings commentedComment #9
jhodgdonThis has some whitespace problems:
And $field should just be "field" without the $ here, I think -- $field is referring to the field information, which isn't what $instance contains (it contains the field data).
Also, $items is not passed by reference in this function, so I think this change is wrong:
Finally, I think this sentence should say "of type $entity_type":
Comment #10
James_Stallings commentedComment #11
jhodgdonOne other thing that needs fixing (see comment #2):
And the description says "field values" - perhaps that should be reworded to say it's only for one field on one entity instance?
The changes in the current patch look good -- I just think we need slightly more.
Comment #12
James_Stallings commentedComment #13
jhodgdonExcellent, thanks! d8/d7 please...
Comment #14
webchickCommitted and pushed to 8.x and 7.x. Thanks!
Thanks for your attention to the docs queue as well, James! :) Always nice to get an extra set of hands!