Download & Extend

Field info doc has multiple problems

Project:Drupal core
Version:7.x-dev
Component:documentation
Category:bug report
Priority:normal
Assigned:Unassigned
Status:closed (fixed)
Issue tags:Novice

Issue Summary

On http://api.drupal.org/api/function/field_info_fieldable_types/7 it mentions hook_fieldable_info as the source of information to be returned. According to _field_info_collate_types() (http://api.drupal.org/api/function/_field_info_collate_types/7) this is no longer the case and this information is gathered from hook_entity_info.

Comments

#1

Title:Documentation problem with field_info_fieldable_types» field_info_fieldable_types() doc mentions nonexistent hook_fieldable_info()

Good catch! Just needs a patch...

#2

Title:field_info_fieldable_types() doc mentions nonexistent hook_fieldable_info()» Field info doc has multiple problems
Status:active» needs review

Hmmm...

There's a lot more than just this problem in the doc in this file. I also noticed that the doc for hook_entity_info() was formatted badly. Here's a patch to fix up all the doc in modules/field/field.info.inc, as well as the hook_entity_info() doc.

AttachmentSizeStatusTest resultOperations
584296.patch19.57 KBIdleFailed: Failed to apply patch.View details

#3

Status:needs review» needs work

The last submitted patch failed testing.

#4

This patch should probably wait until after the next code freeze milestone for a reroll, because applying it (once rerolled) would presumably cause many other patches to need a reroll.

#5

The convention in core is not to use 3rd person in function summaries.
Those changes are no good:

- * Clear the field info cache without clearing the field data cache.
+ * Clears the field info cache without clearing the field data cache.

#6

RE #5 - the convention is to use 3rd person, actually. It's just not very well followed.
http://drupal.org/node/1354

#7

Status:needs work» needs review

Here's a patch reroll.

AttachmentSizeStatusTest resultOperations
584296reroll.patch14.49 KBIdlePassed on all environments.View details

#8

Status:needs review» reviewed & tested by the community

Great cleanup. Thanks !

#9

Status:reviewed & tested by the community» fixed

Committed to CVS HEAD. Thanks.

#10

Status:fixed» closed (fixed)

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