WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

#27065 closed enhancement (fixed)

Improve Customizer API documentation

Reported by: ericlewis Owned by: nacin
Milestone: 3.9 Priority: normal
Severity: normal Version: 3.4
Component: Customize Keywords: has-patch
Focuses: docs Cc:
PR Number:

Description

In my work on the metadata UI API, I've found it helpful to document an existing, very related API: the Customizer API. I found it scant on inline documentation, and would like to offer what I have done already.

I was inspired a bit by wonderboymusic's work in #26870, and when he says "As a community, we need to help each other learn what it is and what it does." Feel you dog.

Attachments (1)

27065.diff (19.2 KB) - added by ericlewis 6 years ago.

Download all attachments as: .zip

Change History (4)

@ericlewis
6 years ago

#1 @ericlewis
6 years ago

attachment:27065.diff is a start. Inline documentation is corrected where invalid, and added onto where helpful in the server-side code of the Customizer API.

Last edited 6 years ago by ericlewis (previous) (diff)

#2 @SergeyBiryukov
6 years ago

  • Component changed from Options, Meta APIs to Appearance
  • Focuses accessibility removed
  • Keywords has-patch added
  • Milestone changed from Awaiting Review to 3.9

#3 @nacin
6 years ago

  • Owner set to nacin
  • Resolution set to fixed
  • Status changed from new to closed

In 27398:

Update the Customizer API inline docs.

props ericlewis.
fixes #27065.

Note: See TracTickets for help on using tickets.