WordPress.org
Get WordPress

Make WordPress Core

Opened 9 years ago

Closed 9 years ago

Last modified 9 years ago

#34856 closed defect (bug) (fixed)

Document optional parameters in get_archives_link()

Reported by: swissspidy's profile swissspidy Owned by: swissspidy's profile swissspidy
Milestone: 4.5 Priority: normal
Severity: normal Version:
Component: Permalinks Keywords: good-first-bug has-patch commit
Focuses: docs Cc:

Description

As per the @todo comment in get_archives_link(), the function's docblock could be improved. The description and default value for optional params are currently missing.

See the ​PHP documentation standards for more details.

Attachments (1)

general-template.php.diff​ (840 bytes) - added by kiranpotphode 9 years ago.
Patch file. Included Documentation for before and after optional arguments.

Download all attachments as: .zip

Change History (6)

@kiranpotphode
9 years ago

Patch file. Included Documentation for before and after optional arguments.

#1 @kiranpotphode
9 years ago

  • Keywords has-patch added; needs-patch removed

#2 @swissspidy
9 years ago

  • Milestone changed from Awaiting Review to 4.5
  • Owner set to swissspidy
  • Status changed from new to reviewing

#3 @swissspidy
9 years ago

  • Keywords commit added

#4 @SergeyBiryukov
9 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 35886:

Docs: Document optional parameters in get_archives_link().

Props kiranpotphode.
Fixes #34856.

#5 @SergeyBiryukov
9 years ago

In 35887:

Docs: Remove @todo entry from get_archives_link(), as all optional arguments are now documented.

See #34856.

Note: See TracTickets for help on using tickets.