form_textfield doc should say name param is automatically enclosed in []'s
bslade - March 25, 2005 - 16:52
| Project: | Drupal |
| Version: | 4.6.x-dev |
| Component: | documentation |
| Category: | bug report |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | won't fix |
Jump to:
Description
I'm a newbie, so if this is innappropriate, please be polite...
In drupaldocs.org, in the form_textfield page, I would request changing the doc info for the name param to (emphasis added for new text):
$name The internal name used to refer to the field. The value is automatically enclosed in square brackets before it's used.
You can figure it out from the code at the end of the doc page, but documentation is supposed to help by letting you skip having to read the code.
Ben in DC
PublicMailbox at benslade dot com
(append 030516 to the subj line to bypass spam filters)
#1
moving to documentation since forms is wrong module.
-1 since a themed functioned is being called.
#2
This page is now: http://api.drupal.org/api/4.6/function/form_textfield
I have no comment on anything else. ^.^
Anisa.
#3
The only way to fix API documentation, is by submitting a patch against Drupal core. This is not an issue for the documentation team so feel free to move it to the Drupal project instead.
#4
Are you really sure? I seem to recall some people think the other way around. If that's the verdict, I'll happily shift the whole lot, but I want to double check.
Anisa.
#5
The content on api.drupal.org is automatically generated from the phpdoc comments in the source. So you need to get a patch containing the change into core, and then it will propagate to api.
#6
moved from the doc issue queue - still relevant?
#7
The reference for form_textfield only shows up in Drupal 4.6. There is no mention of form_textfield for Drupal 4.7, 5, or 6.
Since Drupal 4.x is no longer being developed, I'm setting this to "won't fix."
#8
Sorry. Meant to set it back to 4.6 as well.