Compare:

  /**
   * Add a table to the query, without ensuring the path.
   *
   * This function will test to ensure that the path back to the primary
   * table is valid and exists; if you do not wish for this testing to
   * occur, use $query->queue_table() instead.
   *
   * @param $table
...
   */
  function queue_table($table, $relationship = NULL, $join = NULL, $alias = NULL) {

with

  /**
   * Add a table to the query, ensuring the path exists.
   *
   * This function will test to ensure that the path back to the primary
   * table is valid and exists; if you do not wish for this testing to
   * occur, use $query->queue_table() instead.
   *
   * @param $table
...
   */
  function add_table($table, $relationship = NULL, $join = NULL, $alias = NULL) {

It seems like the second paragraph was copy pasted. queue_table() does not call ensure_path(). I'd roll a patch but I'm not sure what to replace that paragraph with.

This appears to affect 7.x, 6.x-2.x and 6.x-3.x.

CommentFileSizeAuthor
#3 657578-63x_comment_0.patch1001 bytesiamjon
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

dawehner’s picture

Version: 7.x-3.x-dev » 6.x-2.x-dev

Update version

esmerel’s picture

Assigned: Unassigned » esmerel
iamjon’s picture

Version: 6.x-2.x-dev » 6.x-3.x-dev
Status: Active » Needs review
FileSize
1001 bytes

Patch attached.
Changed it to:
Add a table to the query without ensuring the path. If you require that this testing
occur use $query->add_table() instead.

dawehner’s picture

Status: Needs review » Reviewed & tested by the community

Looks fine

esmerel’s picture

Assigned: esmerel » Unassigned

Unassigning from myself since I didn't do the work, and dereine has already reviewed it :)

merlinofchaos’s picture

Technically with doxygen we should only have one sentence on the first line, as that is the 'summary' you'll get when listing methods. Otherwise it's fine.

merlinofchaos’s picture

Status: Reviewed & tested by the community » Fixed

I updated the text and committed to all 3 branches.

Status: Fixed » Closed (fixed)

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