[wp-hackers] Codex function page proposal

Daniel Torreblanca regulatethis at gmail.com
Sat Dec 27 21:55:31 GMT 2008


I think it's great, I'm a big fan of the php function reference, it's
very consistent and easy to find what you're looking for.
Your example looks good, barring some aesthetic issues (the TOC is
awkwardly-placed), but those aren't really a big deal.

On Sat, Dec 27, 2008 at 3:46 PM, Gaarai <gaarai at gaarai.com> wrote:
> I've spent the past couple of days working on a new style for the function
> pages on the Codex. I did a lot of research on different documentation
> sites. Eventually, I found that the PHP Function Reference
> <http://us2.php.net/manual/en/funcref.php>, has what I consider the most
> straightforward, intuitive function documentation style.
>
> In order to see how the PHP style would work on the Codex, I created a new
> function reference rough draft to try it out. My results can be found here
> <http://codex.wordpress.org/User:Chrisbliss18/wp_cache_add>
> (http://codex.wordpress.org/User:Chrisbliss18/wp_cache_add).
>
> For those that don't know why I'm doing this, I'm trying to get a standard
> format that can be used for all functions in order to make using the Codex
> more consistent and creating/editing pages quicker and easier.
>
> With that in mind, I'd like to get feedback on what everyone thinks about
> this format.
>
> What do you like and dislike about it?
> Would this format make using the Codex easier or more difficult?
> Would this format make adding/editing the Codex easier or more difficult?
>
> --
> Chris Jean
> http://gaarai.com/
> http://wp-roadmap.com/
>
> _______________________________________________
> wp-hackers mailing list
> wp-hackers at lists.automattic.com
> http://lists.automattic.com/mailman/listinfo/wp-hackers
>


More information about the wp-hackers mailing list