Make WordPress Core

Opened 11 years ago

Closed 11 years ago

Last modified 11 years ago

#25186 closed defect (bug) (fixed)

Document the allowed parameters for get_pages()

Reported by: wonderboymusic's profile wonderboymusic Owned by: wonderboymusic's profile wonderboymusic
Milestone: 3.7 Priority: normal
Severity: normal Version: 1.5
Component: Inline Docs Keywords: has-patch
Focuses: Cc:


I found some craziness in #9470. It's no wonder: there is almost no documentation for the parameters one can pass to get_pages(). We should add some.

Attachments (5)

25186.diff (2.3 KB) - added by DrewAPicture 11 years ago.
25186.2.diff (2.2 KB) - added by wonderboymusic 11 years ago.
25186.3.diff (3.5 KB) - added by DrewAPicture 11 years ago.
25186.4.diff (4.0 KB) - added by nacin 11 years ago.
25186.5.diff (3.8 KB) - added by DrewAPicture 11 years ago.

Download all attachments as: .zip

Change History (12)

#1 @DrewAPicture
11 years ago

This one is definitely near the top of the list. A first-round patch is welcome, but we'd like it to conform to the soon-to-be public inline-docs standards, so don't overexert too much just yet :)

11 years ago

#2 @DrewAPicture
11 years ago

  • Cc xoodrew@… added
  • Keywords has-patch added; needs-patch removed

25186.diff documents the arguments in the new hash notation style :)

Could probably add a long description here, and docs for the filter(s) will be added separately.

#3 @wonderboymusic
11 years ago

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

In 25266:

Add docs to the woefully under-documented get_pages().

Props DrewAPicture.
Fixes #25186.

#4 @DrewAPicture
11 years ago

  • Keywords needs-docs removed

#5 @DrewAPicture
11 years ago

@wonderboymusic mind also committing the spacing etc. fixes in 25186.3.diff?

#6 @wonderboymusic
11 years ago

In 25268:

Fix spacing in docs for get_pages().

Props DrewAPicture.
See #25186.

11 years ago

#7 @nacin
11 years ago

In 25271:

More adjustments and improvements for inline documentation for get_pages(). see #25186.

Note: See TracTickets for help on using tickets.