php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login

go to bug id or search bugs for

Doc Bug #80060 Use PSR coding guidelines in PHP.net docs (instead of PEAR-CS)
Submitted: 2020-09-04 12:25 UTC Modified: 2020-09-04 15:53 UTC
From: t dot motylewski at gmail dot com Assigned: kalle (profile)
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS:
Private report: No CVE-ID: None
View Add Comment Developer Edit
 [2020-09-04 12:25 UTC] t dot motylewski at gmail dot com 
Description:
------------
Right now (as stated here: http://doc.php.net/tutorial/style.php) the code style used in PHP documentation is PEAR-CS https://pear.php.net/manual/en/coding-standards.php

PEAR-CS covers much less of the PHP language capabilities than PSR-1,2,12, it has much smaller adoption and PEAR in general looks unmaintained.

I suggest that the new coding standard for PHP docs should be PSR.

Patches

Add a Patch

Pull Requests

Pull requests:

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2020-09-04 12:42 UTC] requinix@php.net
-Status: Open +Status: Suspended
 [2020-09-04 12:42 UTC] requinix@php.net 
The PSRs are unofficial community-written guidelines for interoperability between frameworks and projects. If PHP were to follow their guidelines then that could be interpreted as an endorsement - reasoning that extends to other areas, such as why php.net does not employ a popular framework.

Whether or not to continue that philosophy is beyond the scope of this bug tracker and would need to be discussed internally through the mailing list.
https://www.php.net/mailing-lists.php
 [2020-09-04 15:53 UTC] kalle@php.net
-Status: Suspended +Status: Closed -Assigned To: +Assigned To: kalle
 [2020-09-04 16:01 UTC] sergey@php.net 
Also, you can send PR to doc-repo with PSRs code style.
 [2024-03-05 21:56 UTC] emovers123u at gmail dot com 
The following pull request has been associated:

Patch Name: Update HTTP URLs to HTTPS where appropriate
On GitHub:  https://github.com/php/doc-base/pull/42
Patch:      https://github.com/php/doc-base/pull/42.patch
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved. 		Last updated: Fri May 10 23:01:30 2024 UTC