WordPress.org
Get WordPress

Make WordPress Core

Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#50248 closed defect (bug) (invalid)

post_comments_feed_link() missing Return inline doc

Reported by: stevenlinx's profile stevenlinx Owned by:
Milestone: Priority: normal
Severity: normal Version:
Component: Comments Keywords: has-patch
Focuses: docs Cc:

Description

The return section need to be migrated from Codex.

post_comments_feed_link() | Codex
​https://codex.wordpress.org/Function_Reference/post_comments_feed_link

post_comments_feed_link() | DevHub
​https://developer.wordpress.org/reference/functions/post_comments_feed_link/

Attachments (1)

50248.diff​ (748 bytes) - added by stevenlinx 4 years ago.

Download all attachments as: .zip

Change History (5)

@stevenlinx
4 years ago

#1 @stevenlinx
4 years ago

  • Keywords has-patch added; needs-docs removed

#2 @SergeyBiryukov
4 years ago

  • Milestone changed from Awaiting Review to 5.5

#3 @SergeyBiryukov
4 years ago

  • Milestone 5.5 deleted
  • Resolution set to invalid
  • Status changed from new to closed

Hi there, thanks for the patch!

post_comments_feed_link() echoes for value​ of get_post_comments_feed_link(), and does not return it.

get_post_comments_feed_link() already has a @return value​, so the existing documentation is correct.

Last edited 4 years ago by SergeyBiryukov (previous) (diff)

#4 @stevenlinx
4 years ago

Yuck!

The doc for the Codex was wrong to begin with. There shouldn't be a "Return Values" section.
​https://codex.wordpress.org/Function_Reference/post_comments_feed_link

Thanks.

Last edited 4 years ago by stevenlinx (previous) (diff)
Note: See TracTickets for help on using tickets.