10 Comments

  1. David Gwyer

    This is great news for WordPress core docs. The more comments in core the better, especially for new users!

    Report

  2. Devtard

    Well, the complete documentation also has to be added to the Codex, otherwise it isn’t really useful. Finding how the stuff works while browsing through random code isn’t very user-friendly. Ain’t nobody got time for that.

    Report

  3. Rudd

    Woot woot!

    Report

  4. DrewAPicture

    Hi Sarah, I’m one of the leaders of the inline docs initiative for 3.7 (and beyond).

    I notice you didn’t mention the forthcoming Code Reference, which will live at develop.wordpress.org and is in actuality the driving force behind documenting these hooks and filters.

    The Code Reference will use a parser to pull the inline docs of hooks, filters, functions, and classes into a dynamic web reference (similar in many ways to queryposts.com). So if the docs aren’t there, they won’t get parsed, thus the big push!

    It’s also important to keep in mind that ultimately the Code Reference will in-effect replace huge chunks of the Codex, including the Function Reference, Class Reference, Filter Reference and a bunch of other stuff. We’ll bring together vetted examples and other interactivity we would have had to manually generate before.

    And yes, it’s definitely about making extra information about all hooks and filters more readily available to anybody who wants to know.

    If you’d like to know more about future plans of documenting WordPress, check out the roadmap we developed over the summer.

    Report

  5. Sarah Gooding

    @DrewAPicture – Awesome Drew! Thanks for expanding on that. This is really an exciting year for the codex.

    Report

  6. Andreas Nurbo

    excellent stuff. its much needed.

    Report

  7. Joan

    Great news! Documented hooks… what else can web ask for?

    Report

  8. Ruairi Phelan

    This will save a lot of foraging in the codex…. best news all week!

    Report

  9. Jeffro

    @Devtard – The Codex will be disappearing in the future in one form or another. Instead, most of this stuff will be added to the Develop.WordPress.org site mentioned by Drew. Some of it may also end up in a handbook.

    This is one of those huge efforts that may get unnoticed in the future but I’m glad Brian Richards, Drew and others are going through with it. It’s one of those things that if it gets done now, it will have huge positive gains for the future.

    Report

  10. WordPress Inline Documentation Marches Forward: 50% Complete

    […] the Inline Documentation project was started in July at WordCamp San Francisco, a handful of contributors set out to tackle a […]

    Report

Comments are closed.

%d bloggers like this: