Add cross-references between taxonomy_vocabulary_load() and taxonomy_vocabulary_machine_name_load() [#1370060]

I can never remember the name of taxonomy_vocabulary_machine_name_load(). I always look up taxonomy_vocabulary_load() hoping there will be a @see reference, which there isn't. Eventually I left a comment to remind my future self about it. It seems to me it would be a good idea for each function to refer to the other.

Comment	File	Size	Author
#6	13700600-taxonomy_vocabulary_reference-3.patch	1000 bytes	chris.leversuch
#6
#2	taxonomy_vocabulary_reference-13700600-2.patch	720 bytes	jvns
#2

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 14 December 2011 at 15:46

Issue tags:

+Novice

Sounds reasonable. Just needs a patch -- probably good Novice project.

Comment #2

jvns CreditAttribution: jvns commented 15 December 2011 at 17:54

Status:

Active

» Needs review

File	Size
taxonomy_vocabulary_reference-13700600-2.patch	720 bytes

Comment #3

chris.leversuch CreditAttribution: chris.leversuch commented 15 December 2011 at 20:15

Status:

Needs review

» Needs work

I think @see should be at the end of the doc header

Comment #4

jvns CreditAttribution: jvns commented 15 December 2011 at 20:25

I thought so too, but everywhere elsewhere in taxonomy.module @see is before @param, so I went with that. Not clear to me what the right thing to do is. (fix it everywhere?)

Comment #5

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 15 December 2011 at 21:52

We're in the midst of cleaning up the Drupal 8 documentation so it conforms with our standards on this issue:
#1310084: [meta] API documentation cleanup sprint
The taxonomy module hasn't been done yet, and moving the @see to the end of the doc blocks is one of the cleanup tasks.

For this issue, please just do these functions right, and don't clean up the rest of the file. But if you're interested in cleaning up, you can join in the cleanup issue -- there are instructions there. :)

By the way, standards for how to do doc headers correctly are at:
http://drupal.org/node/1354