Document nocache_headers() usage in wp-admin/admin-post.php

[ronakganatra]

nocache_headers(); is used but unclear as to what it actually does. documentation need improvement

[ronakganatra]

added description for used function nocache_headers();

[SergeyBiryukov]

Hi @ronakganatra, welcome to WordPress Trac! Thanks for the patch.

There are more than 15 instances of nocache_headers() calls in core though, adding a comment to only one of them seems inconsistent. The function itself already has a description, maybe it should be made clearer?

[pyrobd]

Hello @SergeyBiryukov ,
Do you mean just adding comments to all the instances?

[SergeyBiryukov]

Replying to pyrobd:

Do you mean just adding comments to all the instances?

Not really, I meant that the function itself already has a description to clarify its purpose, so I don't see a significant benefit in duplicating it in other instances. So unless there is something to improve in the function description, I think this ticket can be closed.

I guess the point of the ticket was that in this particular file, the send_origin_headers() call has a comment while nocache_headers() does not, which might seem a bit inconsistent. Then again, if the code is mostly self-documenting, I don't think it's necessary to add a comment for every single function call. Note that the send_origin_headers() comment does not just duplicate the function description but provides some more context.

[pyrobd]

Thanks Understood, I also think it can be closed, the existing description is pretty clear, just browsing through tickets to create my first accepted Patch.