hook_entity_info() docs for uri callback should say ie not eg [#1797682]

API page: http://api.drupal.org/api/drupal/modules%21system%21system.api.php/funct...

A function taking an entity as argument and returning the URI elements of the entity, e.g. 'path' and 'options'. The actual entity URI can be constructed by passing these elements to url().

This callback is responsible for providing what http://api.drupal.org/api/drupal/includes!common.inc/function/entity_uri/7 returns, and reading the docs for that function it looks like 'path' and 'options' are expected.

Therefore, this should say 'ie', not 'eg'.

(And we need #1250500: [policy adopted; patch done] Find a (standard) way to document callback signatures...)

Comments

Comment #1

jhodgdon

she/her

English

commented 28 September 2012 at 15:43

There is a separate issue that was getting rid of all the i.e. and e.g. in documentation... it might still be open, and if so we should combine this with that other issue. If not, the decision we made in that issue was to just eliminate i.e. and e.g. and in this case, it seems like the documentation should be rewritten to say what really needs to be returned.