Posted by linclark on October 16, 2009 at 9:02pm
| Project: | Drupal core |
| Version: | 6.x-dev |
| Component: | documentation |
| Category: | bug report |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | closed (fixed) |
| Issue tags: | Novice |
Issue Summary
The return value is documented as "HTML for the form element", but it would seem that it returns an array that is an abstract representation of an HTML form element, not the HTML itself
Comments
#1
Good catch! This is wrong in both Drupal 7 http://api.drupal.org/api/function/filter_form/7 and Drupal 6 http://api.drupal.org/api/function/filter_form/6 and should be fixed in Drupal 7 first, then the fix should be backported to Drupal 6.
#2
Here's a patch for Drupal 7. Should be ported to Drupal 6 if accepted.
#3
Committed to CVS HEAD. Moving to D6 so we can reroll for D6.
#4
Here's a doc patch for Drupal 6. Since the original doc for D6 has a see also to a validation function, I decided that validation function needed a doc header as well...
#5
+++ modules/filter/filter.module 23 Oct 2009 14:24:23 -0000@@ -470,18 +470,23 @@
+ * @see filter_form_validate().
*
- * @ingroup forms
- * @see filter_form_validate()
* @param $value
[...]
+ *
+ * @ingroup forms
Nit-pick: The @see should probably move back down beneath the @ingroup, unless I've missed some code style discussion. :x
#6
Fair enough. Here's a redo.
#7
I just noticed an extra space. Try this patch instead.
#8
Looks good to me.
#9
Thanks, committed.
#10
Automatically closed -- issue fixed for 2 weeks with no activity.