Download & Extend

taxonomy_get_children return value doc is not complete

Project:Drupal core
Version:8.x-dev
Component:documentation
Category:bug report
Priority:normal
Assigned:Unassigned
Status:closed (fixed)
Issue tags:needs backport to D7

Issue Summary

API page: http://api.drupal.org/api/drupal/modules--taxonomy--taxonomy.module/func...

Describe the problem you have found:

The return value can also be an empty array, when no childs are found. This is not described in the Return value. Users with smart IDEs will benefit from these kind of correct informations.

ps: can somebody please set the Drupal Core version to 7.2 (aka current stable) instead of 7.x-dev when reporting issues? Or is that intended?

Comments

#1

Title:Documentation problem with taxonomy_get_children» taxonomy_get_children return value doc is not complete
Version:7.x-dev» 8.x-dev

The version is intentional. We fix issues in the in-development version (which in this case is actually 8.x), not in specific versions of Drupal.

#2

Assigned to:Anonymous» James_Stallings

Learning a bit about the taxonomy module this month :)

#3

Status:active» needs review
AttachmentSizeStatusTest resultOperations
taxonomy_get_children_patch1_1196108_4637958.patch629 bytesIdlePASSED: [[SimpleTest]]: [MySQL] 33,586 pass(es).View details

#4

Assigned to:James_Stallings» Anonymous

#5

Status:needs review» needs work

Looks OK... Punctuation/grammar nerdiness -- should be:

An array of term objects that are the children of the term $tid, or an empty array when no children exist.
(which -> that, and a comma before the 2nd clause)

#6

Sure, I'll fix that tonight. How come your the only one to ever respond to these issues :P How large is the doc team?

#7

The docs team is fairly large actually, but most people in the docs team work on on-line documentation (the docs on drupal.org/documentation). The subset who work on API documentation on a regular basis is fairly small right now (you and a few other people), but highly appreciated!

As far as responding goes... Currently, I seem to be the only person who regularly reviews documentation patches -- you and the other team members mostly make patches. That seems to be working pretty well, though -- I have enough time to keep up with the reviews, and I definitely want to make sure the standards are being followed consistently... and as the Docs team leader responsible for the API docs, I am also interested in mentoring new contributors, getting them used to the standards, etc.

The other reason I end up being the person who responds is that I'm the person who triages the new issues in the documentation component of the Drupal Core issue queue, so I end up subscribed to nearly all of the documentation issues and get email when a new patch is submitted.

All of that said, if you would like to review docs patches, you can search for issues in the documentation component marked "needs review". There are some there that do need reviews (especially anything that I patched, since I can't review my own patches).

#8

Status:needs work» needs review
AttachmentSizeStatusTest resultOperations
taxonomy_get_children_patch2_1196108_4783138.patch629 bytesIdlePASSED: [[SimpleTest]]: [MySQL] 33,600 pass(es).View details

#9

Status:needs review» reviewed & tested by the community

Looks good for 8.x/7.x, thanks!

#10

Status:reviewed & tested by the community» fixed

Committed to 8.x and 7.x. Thanks! :)

#12

Status:fixed» closed (fixed)

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

nobody click here