[documentation] [Documentation bug] form_textfield doc should say name param is automatically enclosed in []'s

rivena drupal-docs at drupal.org
Mon Jun 19 07:01:03 UTC 2006


Issue status update for 
http://drupal.org/node/19441
Post a follow up: 
http://drupal.org/project/comments/add/19441

 Project:      Documentation
 Version:      <none>
 Component:    Misc
 Category:     bug reports
 Priority:     normal
 Assigned to:  Anonymous
 Reported by:  bslade
 Updated by:   rivena
 Status:       active

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.




rivena



Previous comments:
------------------------------------------------------------------------

Fri, 25 Mar 2005 16:52:31 +0000 : bslade

I'm a newbie, so if this is innappropriate, please be polite...


In drupaldocs.org, in the form_textfield [1] 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] http://drupaldocs.org/api/head/function/form_textfield




------------------------------------------------------------------------

Wed, 29 Jun 2005 00:17:40 +0000 : dtan

moving to documentation since forms is wrong module.  


-1 since a themed functioned is being called.




------------------------------------------------------------------------

Thu, 15 Jun 2006 16:18:21 +0000 : rivena

This page is now: http://api.drupal.org/api/4.6/function/form_textfield


I have no comment on anything else.  ^.^


Anisa.




------------------------------------------------------------------------

Sun, 18 Jun 2006 07:17:20 +0000 : Dries

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.






More information about the documentation mailing list