WordPress.org

Make WordPress Core

Opened 3 weeks ago

Closed 3 weeks ago

#48614 closed defect (bug) (fixed)

Return type of comments_link_feed uses invalid phpdoc keyword

Reported by: diddledan Owned by: SergeyBiryukov
Milestone: 5.4 Priority: normal
Severity: trivial Version: trunk
Component: Feeds Keywords: has-patch
Focuses: docs Cc:
PR Number:

Description

In wp-includes/feed.php the return type of comments_link_feed is documented as none, which is not a valid keyword according to the phpdoc specification: https://docs.phpdoc.org/guides/types.html

The attached patch corrects none to be void. Alternatively the @return documentation tag might be removed altogether for the same effect.

Attachments (1)

48614.patch (735 bytes) - added by diddledan 3 weeks ago.
Patch to set return type to void

Download all attachments as: .zip

Change History (3)

@diddledan
3 weeks ago

Patch to set return type to void

#1 @SergeyBiryukov
3 weeks ago

  • Milestone changed from Awaiting Review to 5.4

I think this can just be removed. Per the documentation standards:

Note: @return void should not be used outside of the default bundled themes.

#2 @SergeyBiryukov
3 weeks ago

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

In 46732:

Docs: Remove incorrect @return tags.

Props diddledan.
Fixes #48613, #48614.

Note: See TracTickets for help on using tickets.