Closed (fixed)
Project:
Drupal core
Version:
7.x-dev
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
24 Apr 2014 at 13:23 UTC
Updated:
27 Jun 2014 at 21:30 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
jhodgdonThanks! yeah. Probably an @see to the module function and an update to the docs would be appropriate. It should follow the standards in: https://drupal.org/node/1354#callbacks
And this is 8.x also.
Comment #2
c31ck commentedChanged the docblock: added the @see to system_sort_modules_by_info_name(), added the callback information.
Comment #3
c31ck commentedComment #4
wim leerss/uasort/uasort()/
We just refer to functions, without additional information. The extra information can be found at that other function's documentation. So just
is sufficient.
Comment #5
c31ck commentedFixed both remarks.
Comment #6
c31ck commentedComment #7
wim leersComment #9
richard.c.allen2386 commentedLooking to help finish up this issue tonight at a ladder sprint. I'm confused though, looks like patch 5 is failing but the issue was sent to community review? Am I missing something? Not sure where to pick up the issue.
Comment #10
jhodgdonThe test failures are not related to this patch. Sometimes the test bot has problems. Ignore them.
Regarding the latest patch, it looks good to me except the first line, which says:
Array sorting callback; sorts themes by their name.
Please take out the "Array sorting callback;" part. It is not necessary, since the rest of the doc block explains that it is a callback.
Comment #11
amitgoyal commented@jhodgdon - Please review updated patch which takes out the "Array sorting callback;" part.
Comment #12
jhodgdonThanks, that looks better!
Comment #13
jhodgdonThanks again! Committed to 8.x. Needs backport to 7.x now.
Comment #14
amitgoyal commentedThanks @jhodgdon!
Please see patch for D7.
Comment #15
David_Rothstein commentedComment #16
jhodgdonThanks! The backport is correct, but I just noticed (doh!) that the function actually sorts themes with the default theme first, and then by name within the other non-default themes. So I think we should probably to back and fix the 8.x documentation and then return to 7.x. Just saying it sorts themes by name is not actually accurate.
Comment #17
amitgoyal commentedPlease review the updated patch for 8.x as per #16.
Comment #18
jhodgdonThanks! But the first-line documentation for a function needs to be one line. See:
https://drupal.org/node/1354#drupal
How about:
Sorts themes by their names, with the default theme listed first.
Comment #19
amitgoyal commentedSounds much better!
Please review revised patch.
Comment #20
jhodgdonThat works for me (not surprising). :)
Comment #21
jhodgdonThanks again! Committed to 8.x.
We now need patch #14 updated with the text change in #19 for D7.
Comment #22
amitgoyal commentedThanks @jhodgdon!
Please see revised patch for D7 with the text change in #19.
Comment #23
jhodgdonThanks!
Comment #24
jhodgdonThanks again all! Committed to 7.x.