Documentation errors in og_vocab.module [#1881996]

/**
 * Access function to determine if a user has access to the menu item.
 *
 * @param $node
 *   The group node.
 * @param $perm
 *   The permission to check is user has.
 * @param $vid
 *   Optional; The vocabulary ID.
 *
 * @return
 *   TRUE if user has access to the menu item.
 */
function og_vocab_vocabulary_access($entity_type, $entity_id, $perm, $vocabulary = NULL) {
  if (!$entity = entity_load_single($entity_type,$entity_id)) {
    return FALSE;
  }

Here the number of function parameters and variable names have difference.

Comment	File	Size	Author
#3	og_vocab-documentation_error_in_function_og_vocab_is_og_vocab_field-1881996-3.patch	794 bytes	Jerenus
#3
#1	og_vocab-documentation_error_in_function_og_vocab_vocabulary_access-1881996-1.patch	932 bytes	Jerenus
#1

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

Jerenus CreditAttribution: Jerenus commented 7 January 2013 at 11:46

File	Size
og_vocab-documentation_error_in_function_og_vocab_vocabulary_access-1881996-1.patch	932 bytes

Here is my patch.

Comment #2

amitaibu

Hebrew

Israel

CreditAttribution: amitaibu commented 9 January 2013 at 08:27

Status:

Needs review

» Fixed

Committed, thanks.

Comment #3

Jerenus CreditAttribution: Jerenus commented 13 January 2013 at 06:10

Status:

Fixed

» Needs review

File	Size
og_vocab-documentation_error_in_function_og_vocab_is_og_vocab_field-1881996-3.patch	794 bytes

/**
 * Return TRUE if field is associated with OG-vocab.
 *
 * @param $field_name
 *   The field name.
 *
 * @see og_is_group_audience_field()
 */
function og_vocab_is_og_vocab_field($entity_type, $field_name, $bundle_name) {

Another one in function og_vocab_is_og_vocab_field.

Another patch.