status_header() incorrect return statement

[tivnet]

Attempt to return @header(... while header() is void.

[SergeyBiryukov]

Should we perhaps just omit the return (like in #25450), to keep the current behaviour?

[tivnet]

Replying to SergeyBiryukov:

Should we perhaps just omit the return (like in #25450), to keep the current behaviour?

In this specific function, boolean return can make some sense, in my opinion.
For example, we can add headers_sent() validation, and return false if already sent?

You are right, the simplest patch would be indeed just omitting the return. But, do we expect anyone to really know if the method worked? If yes, then boolean return can be a good start...

[tivnet]

Version w/o @return

[tivnet]

Replying to SergeyBiryukov:

Should we perhaps just omit the return (like in #25450), to keep the current behaviour?

Made a new patch. Please take a look. Thank you!

[tivnet]

Replying to SergeyBiryukov:

Sergey, could you please make a resolution on this? The most recent patch does not have the @return.
Thank you!

[SergeyBiryukov]

25451.patch​ is another take. Renamed some variables for clarity. Removed @uses apply_filters(), as the filter itself should be documented instead.

[DrewAPicture]

Replying to SergeyBiryukov:

25451.patch​ is another take. Renamed some variables for clarity. Removed @uses apply_filters(), as the filter itself should be documented instead.

25451.patch​ works for me. +1 for documenting with code :)

[SergeyBiryukov]

In 25990:

Remove incorrect @return value from status_header(). Rename some variables for clarity.

props tivnet for initial patch.
fixes #25451.