Re: Coding standard for examples in documentation

From: Date: Tue, 15 Oct 2024 12:54:19 +0000
Subject: Re: Coding standard for examples in documentation
References: 1  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969388443@lists.php.net to get a copy of this message
On 14.10.2024 at 21:43, Jim Winstead wrote: > The coding style for the documentation has been documented to be the PEAR coding standard > (https://pear.php.net/manual/en/standards.php) which is more than a little out-dated at this point. > This has come up in at least a few PR reviews recently. > > Any objections to changing this to the PER Coding Style 2.0 > (https://www..php-fig.org/per/coding-style/)? > > I don't think we should be aggressive about going in and updating existing examples, but > should strive to make sure that new and changed examples are in sync with the new CS through reviews > and perhaps automated checks. > > (I guess the last time this came up it got bogged down in the quagmire about whether using a > PHP-FIG standard implied some sort of favoritism or endorsement or whatever. Maybe we'll have > to open a RFC on internals@ to address this documentation issue? > https://news-web.php.net/php.doc/969387610) Thinking about <https://pear.php.net/bugs/bug.php?id=21036>, I agree that we should switch to something that is up-to-date. Christoph

« previous php.doc (#969388443) next »