Re: Changing our function definition syntax in the manual
| From: | Sherif Ramadan | Date: | Tue, 10 Nov 2015 20:34:10 +0000 |
| Subject: | Re: Changing our function definition syntax in the manual | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969385945@lists.php.net to get a copy of this message | ||
It's a cosmetic change, at best. Clearly this person's reasoning is that
the documentation should provide a 1:1 mapping of the language syntax. I
see no real net-benefit for the documentation itself there.
I'm not opposed to that change. I think it's fine, but I'm not exactly
eager to make such changes in the docs either.
On Tue, Nov 10, 2015 at 3:19 PM, Julien Pauli <jpauli@php.net> wrote:
> Hey people.
>
>
> Today I got twitted about an interresting idea.
>
> The twitt (https://twitter.com/tvlooy/status/664109119343878144) was
> about why don't we show function syntax for description using the new
> declaration syntax used in PHP 7 parser ?
>
> Example for http://php.net/manual/en/function.random-int.php
>
> Actual :
> ********
>
> Description
>
> int random_int ( int $min , int $max )
>
>
> Suggested :
> *************
>
> Description
>
> random_int ( int $min , int $max ) : int
>
>
> This is not senseless , now that we trully support such a syntax in
> the language.
> However, wouldn't such a global manual change hurt some people ?
> I don't know.
>
>
> Thoughts ?
>
>
> Julien Pauli
>