Re: Documentation structure - would love to hear your thoughts
| From: | Nikita Popov | Date: | Fri, 09 Dec 2016 17:29:50 +0000 |
| Subject: | Re: Documentation structure - would love to hear your thoughts | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969386436@lists.php.net to get a copy of this message | ||
On Fri, Dec 9, 2016 at 9:12 AM, Maciej Sobaczewski <sobak@php.net> wrote:
> Hi folks,
>
> I've started a non-binding discussion on /r/php regarding possible ways to
> improve the PHP manual.
>
> https://www.reddit.com/r/PHP/comments/5h7c5w/how_can_be_the_
> php_manual_improved/
>
> I have created bug report to track on of the complaints mentioned there
> https://bugs.php.net/bug.php?id=73698 (and which I also heard
> alot
> before).
>
> What are your thoughts on that topic?
>
> Cheers,
> Maciej.
>
> PS: allowed myself to CC Peter as he's Manual Editor and Christoph as most
> active contributor last times.
>
A somewhat related point: The manual currently does not really distinguish
between core extensions and PECL extensions. The only real indication you
get is a small (PECL xxx >= yyy) in the version line, otherwise it might as
well be a core function. This is suboptimal, because a very large fraction
of PHP developers is limited to the use of core extensions, and it's not
possible to see at a glance which is which. I'd like to see a much larger
distinction here. "Large" on the order of switching the header from green
to blue and replacing the "php" logo with "pecl".
Regards,
Nikita