Omit code output going forward
| From: | Larry Garfield | Date: | Mon, 10 Nov 2025 19:57:08 +0000 |
| Subject: | Omit code output going forward | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969388602@lists.php.net to get a copy of this message | ||
In a couple of issues now, we've run into an impass because it's unclear if we still need
to include the output of code samples in manual pages. There is the new in-page runner, which is
guaranteed to give "correct" results (or error if it's showing a feature that is
incompatible).
I'd like to see us formally and explicitly decide on a policy here.
And I will start by proposing that in most cases, we DO NOT need to include manually-created output,
as the in-page runner is superior and takes less work for doc writers. The only exception is where
the runner doesn't support the code being shown for whatever reason. (Like, it requires a file
system, or some non-loaded extension, etc.) In those cases, the traditional approach with a manual
output block still makes sense. But that's a minority case now.
--
Larry Garfield
larry@garfieldtech.com