Re: documenting constants

Philip Olson wrote:

Two main topics come to mind here: - Layout of constant information As far as I see it, they're all ready for descriptions but are rarely added as it means a lot of extra work looking them all up, and putting that information into laymen's terms (or coming up with a description that isn't simply the constant name written out). If these constant lists should be in a table, or the current variablelist, I don't know. The mysqli table uses a two column table, the ref.info table three, and the errorfunc table has four; and most all other extensions use a variablelist with an empty description simpara with the idea of later adding the description. Either layout works for me, they each have their pros and cons.

As we won't have a note for each constant, the fourth cell I proposed will be empty most of the time. I think we better go with ref.info style, a table with 3 cells.

- Location of constant information The constants section can get quite large (especially when descriptions are added!) so having all of this information inline the reference at php.net/ref.{ext} can be a little overwhelming. If this were to be in its own section/page, and linked to where the reftitle.constants currently exists, as well as on top of the individual reference TOC's, this might work pretty well.

I like the idea of a separate page for constants, ref.curl is a good example. A link would be more approprieted. After all this, we'll have to fill in the blanks :) didou