Dissatisfaction with new "codex"

  • springthistle

    (@springthistle)


    8 years, 2 months ago

    I’ve been noticing a trend – the codex is being replaced by a new form of documentation that’s not nearly as good.

    The old codex does two valuable things extremely well:
    – Make it very clear exactly what the available arguments are for functions
    – Show (sometimes multiple) great starter code examples

    The new “code reference” often fails at both of these things.

    Good from Codex:
    https://codex.wordpress.org/Function_Reference/register_post_type
    Bad from Developer:
    https://developer.wordpress.org/reference/functions/add_meta_box/

    The new code reference’s inclusion of “source” and “user-contributed notes” is not as useful as the way the codex handled it. The “user-contributed notes” are not authoritative, and are often quirky or for unusual situations, so a function often is missing the basic starter correct example that we see in the codex.

    Is it too late to improve the new code reference to be at least as awesome as the codex?

Viewing 2 replies - 1 through 2 (of 2 total)
  • Andrew Robbins

    (@noclique)

    8 years, 2 months ago

    I completely agree.

    Can we move the basic usage section above the fold or above the Parameters? I think that would dramatically improve the UX.

    etellewyn

    (@etellewyn)

    8 years, 2 months ago

    Yes, add_meta_box is a great “bad” example. I’m not sure what the intent of this developer resource was supposed to be, but for me, instead of pages of discussion including incorrect as well as correct examples, it would be much more useful to ONLY have correct examples given.

Viewing 2 replies - 1 through 2 (of 2 total)
  • The topic ‘Dissatisfaction with new "codex"’ is closed to new replies.