API page: https://api.drupal.org/api/drupal/core%21modules%21field%21field.api.php...

This hook is listed as part of the Field API Bulk Data Deletion topic (group field_purge). That is wrong. It should be in group field_types instead. This could be because it is inside of an "addtogroup" or because it has a wrong "ingroup" in the docs header. Either way, it should be easy to fix.

Also, in the documentation it refers to an exception with the wrong namespace, so it does not turn into a link on this page. Check the example code body, which has the right exception class on it. [this problem vanished]

Comments

gauravkhambhala’s picture

Assigned: Unassigned » gauravkhambhala
gauravkhambhala’s picture

Enter a descriptive title (above) relating to function hook_field_config_update_forbid, then describe the problem you have found:

What should be the title?

This hook is listed as part of the Field API Bulk Data Deletion topic (group field_purge). That is wrong. It should be in group field_types instead. This could be because it is inside of an "addtogroup" or because it has a wrong "ingroup" in the docs header. Either way, it should be easy to fix.

Patch does this job.

Also, in the documentation it refers to an exception with the wrong namespace, so it does not turn into a link on this page. Check the example code body, which has the right exception class on it.

Not getting this. Could you explain more?

jhodgdon’s picture

Issue summary: View changes
Status: Active » Reviewed & tested by the community

Looks good, thanks, on the moving of the hook to the right "group".

Sorry for the confusing line about the title in the issue summary. When you use the "File an issue" link from a page on api.drupal.org, it puts this line in, and I forgot to remove it when I created the issue. I'll remove that now.

Regarding the exception class... that was true when I first created the issue, but it has since been fixed.

So, the patch looks good to me, thanks!

alexpott’s picture

Status: Reviewed & tested by the community » Fixed
Issue tags: +TCDrupal 2014

Committed 717243c and pushed to 8.0.x. Thanks!

  • alexpott committed 717243c on 8.0.x
    Issue #2296787 by gauravkhambhala | jhodgdon: Fixed...

Status: Fixed » Closed (fixed)

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