Closed (fixed)
Project:
Documentation
Component:
API documentation files
Priority:
Normal
Category:
Task
Assigned:
Issue tags:
Reporter:
Created:
19 Aug 2012 at 14:18 UTC
Updated:
4 Jan 2014 at 02:24 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
vasi1186 commentedI created a change notice: http://drupal.org/node/1749954 that documents the new form element.
Comment #2
gábor hojtsySo the task here would be to turn that change notice into a patch for documentation module.
Comment #3
lomo commentedWorking on it. :-)
I've made minor modifications to the change notice. Editing the massive tables will take a while, but most of the change notice can go in with minor formatting changes for consistency.
Comment #4
lomo commentedPatch attached.
Comment #5
lomo commentedHere is the full HTML file, post-patch for easier review (without need to checkout the whole HUGE "documentation" project)
Comment #6
yesct commentedat forms_api_reference.html#options
(and all the other properties used by language_select, other than #languages which is ok)
#language_select needs to be added in the "Used by" alphabetical list.
Why are some of the terms in the Used by alphabetical? Maybe it's ok for some of them since it's copied from what the select list looks like, but here, #languages should not be bold?

Comment #7
yesct commentedComment #8
gábor hojtsyReviewed this in person in detail with LoMo. We found a few issues while reviewing and LoMo cycled those improvements back to the change notice even. It looks good and the code itself is not really reviewable as in the patch (due to the very ugly ways we do these tables). Committed this to the repo, we can always improve on it.
Comment #9
gábor hojtsyCross-post. Now taking patches off of what I committed :)
Comment #10
lomo commentedI think we are good now. :-)
Gábor said that we DO want the bold text for #languages since this will be a new "important element". All "used by" lists now include "language_select" link. Thanks for catching that, YesCT. :-)
Comment #11
lomo commentedThis patch should be what we want, then. :-)
Comment #12
gábor hojtsyCommitted, thanks!
Comment #13
gábor hojtsy@LoMo: the automation of the form API docs is being discussed in #1617948: [policy for now] New standard for documenting form/render elements and properties.