WordPress.org

Make WordPress Core

Opened 5 months ago

Closed 5 months ago

#49076 closed defect (bug) (fixed)

get_comment_author_url() missing inline doc description for Code Reference

Reported by: stevenlinx Owned by: stevenlinx
Milestone: 5.4 Priority: normal
Severity: minor Version:
Component: Comments Keywords: has-patch
Focuses: docs Cc:

Description

The Code Reference page is missing the description field , which the Codex page has. The DevHub (Code Reference) description field came from inline docs of source code header.

Code Reference : get_comment_author_url()
https://developer.wordpress.org/reference/functions/get_comment_author_url/

Codex : get_comment_author_url()
https://codex.wordpress.org/Function_Reference/get_comment_author_url

Attachments (1)

tck49076.diff (696 bytes) - added by stevenlinx 5 months ago.

Download all attachments as: .zip

Change History (5)

@stevenlinx
5 months ago

#1 @stevenlinx
5 months ago

  • Keywords has-patch added; needs-patch needs-docs removed

#2 @SergeyBiryukov
5 months ago

  • Component changed from Administration to Comments
  • Milestone changed from Awaiting Review to 5.4

#3 @SergeyBiryukov
5 months ago

Hi there, welcome back to WordPress Trac! Thanks for the patch.

The "must be within The Loop, or a comment loop" piece is probably not particularly relevant to the specific function, as it applies to other comments template functions as well. The rest looks good, though could perhaps be incorporated into the existing description and @return tag to avoid repetition.

#4 @SergeyBiryukov
5 months ago

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

In 47008:

Docs: Improve documentation for get_comment_author_url().

Props stevenlinx.
Fixes #49076.

Note: See TracTickets for help on using tickets.