... I was having an issue with render arrays (I was trying to use #attach instead of #attached) so I went over to #930760: Render arrays overview and saw that "#attach" wasn't listed. Had "#attached" been listed I clearly would've been ok, but alas....

So I propose that we reorganize in the following way:

  1. Create one page that lists all the possible properties that a render array can handle (wether it be for FAPI, or just a random block). Basically I'm talking about expanding the bottom half of the current FAPI docs and making it its own page.
  2. Create one index page for FAPI and one index page for general Render Arrays with lists of all the appropriate properties (linking to the page I mentioned in #1) noting that overlapping is fine. For FAPI this would probably include the table at the top of the existing docs
  3. On the page described in #1, make sure there are links under each property's description that bring you back to either FAPI or Render Array docs.

Thoughts?

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

See also #100680: [meta] Make API module generate Form API documentation

I think if we are going to reorganize, it's time to make this doc automatically-generated from in-code comments (and thus maintained with the code). Which should be discussed on that other issue.

jn2’s picture

jn2 commented
Status: Active » Closed (duplicate)

@bleen18

There's a discussion of documenting the Render API at #1190658: Where to document the link element (and future Render elements)?. More people have commented there, so I'm closing this as duplicate. Feel free to post your suggestion there. As jhodgdon says, the consensus is that a completely different approach to documenting these elements and properties needs to be devised. But there may be a way to provide some transitional documentation until that happens.