Update all ob_ clean/flush functions #3073

haszi · 2024-01-05T23:22:06Z

Update all six ob_ clean/flush functions' documentation with the following:

describe what each function does in detail
differentiate between contents of the output buffer and values returned by the output handler
list flags passed to output handlers
list flags affecting or, if unexpected, not affecting each function
use consistent terminology for output buffer, it's contents and it's handler, and 'turn off' instead of 'destroy' an output buffer
add a section on notices issued

Girgias

Looks mostly good, although frustrating that there is no way to have a "macro"/"function" in XML as this is a lot of duplicate wording :/

reference/outcontrol/functions/ob-clean.xml

reference/outcontrol/functions/ob-end-clean.xml

reference/outcontrol/functions/ob-clean.xml

reference/outcontrol/functions/ob-end-flush.xml

reference/outcontrol/functions/ob-flush.xml

reference/outcontrol/functions/ob-get-clean.xml

Co-authored-by: Gina Peter Banyard <girgias@php.net>

haszi · 2024-01-07T11:06:41Z

I went with the imperative mood and contents.

haszi added 2 commits January 5, 2024 22:15

[skip-revcheck] Fix whitespace

2fe691e

Update ob_ clean-flush and friends

2d93255

Girgias reviewed Jan 6, 2024

View reviewed changes

Adress first round of review comments

8c0eac2

Co-authored-by: Gina Peter Banyard <girgias@php.net>

Girgias approved these changes Jan 7, 2024

View reviewed changes

Girgias merged commit 86b976d into php:master Jan 7, 2024
2 checks passed

haszi deleted the Update-all-ob_-clean-and-flush-function-docs branch January 7, 2024 14:07

Provide feedback