The Forms API reference is supposed to list all FAPI properties, but does not mention #ref, which has its own documentation elsewhere.

I suggest including it in the table of special properties, with a link to the page documenting it. This is what this patch contains.

CommentFileSizeAuthor
#7 ref6.patch2 KBfgm
#4 ref.patch2.17 KBfgm
forms_api_reference.html.patch963 bytesfgm

Comments

fgm’s picture

fgm
Primary language French
Location Paris, France
commented

Version 1.28 of the reference has added #ref , but the link provided is broken, as are all current links on that page. See:
http://api.drupal.org/api/HEAD/file/developer/topics/forms_api_reference.html

Local links for topic <topic> point to:
http://api.drupal.org/api/HEAD/file/developer/topics/api/head/file/contributions/docs/developer/topics/forms_api_reference.html#<topic>

instead of just #<topic>

brunodbo’s picture

brunodbo
he/him
commented
Project: Documentation » Drupal core
Version: » 7.x-dev
Component: Documentation in CVS » documentation
chx’s picture

chx commented
Status: Needs review » Closed (won't fix)

who pulls up things like this? this property never got in any released Drupal.

fgm’s picture

fgm
Primary language French
Location Paris, France
commented
Status: Closed (won't fix) » Needs review
StatusFileSize
new ref.patch2.17 KB

I can't indeed find it in D5, for which I opened the issue initially. But then the API reference NEEDS to be fixed, because it currently lists this property along with an explanation about its use.

http://api.drupal.org/api/file/developer/topics/forms_api_reference.html...

The suggested patch removes the #ref row in the table and its explanation inline, just like you removed its reference page over two years ago: http://drupal.org/node/51104/revisions

If this is correct, I'll also submit changed to the D6 and D7 FAPI references, which both include the same erroneous information.

Status: Needs review » Needs work

Patch failed to apply. More information can be found at http://testing.drupal.org/node/14105. If you need help with creating patches please look at http://drupal.org/patch/create

catch’s picture

catch
he/him
Primary language English
commented

Patch looks good to me. Shame drupaltestbedbot can't tell it's against 'Documentation in CVS" instead of Drupal.

fgm’s picture

fgm
Primary language French
Location Paris, France
commented
StatusFileSize
new ref6.patch2 KB

And here is the patch for the D6 reference: the #ref row in the table had been removed previously but not the inline description.

Could someone RTBC the patches before I commit them ?

@catch: i opened an issue regarding drupaltestbedbot separately.

fgm’s picture

fgm
Primary language French
Location Paris, France
commented
Status: Needs work » Needs review

Forgot to set status.

Status: Needs review » Needs work

Patch failed to apply. More information can be found at http://testing.drupal.org/node/14137. If you need help with creating patches please look at http://drupal.org/patch/create

catch’s picture

catch
he/him
Primary language English
commented
Status: Needs work » Reviewed & tested by the community

Patches look fine to me.

fgm’s picture

fgm
Primary language French
Location Paris, France
commented
Status: Reviewed & tested by the community » Fixed

Committed respective patches to D5, D6 and HEAD branches.

Anonymous’s picture

Anonymous (not verified) commented
Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for two weeks with no activity.