Newsgroups: php.internals,php.internals
Path: news.php.net
Xref: news.php.net php.internals:110031 php.internals:110032
Return-Path: <sobak@php.net>
Delivered-To: mailing list internals@lists.php.net
Received: (qmail 19458 invoked from network); 6 May 2020 09:16:35 -0000
Received: from unknown (HELO localhost.localdomain) (76.75.200.58)
  by pb1.pair.com with SMTP; 6 May 2020 09:16:35 -0000
To: internals@lists.php.net,"Christoph M. Becker" <cmbecker69@gmx.de>, internals@lists.php.net,
References: <CAF+90c8m-CB3ZxAHeoOJVxJGhysLfZqpz3mq475GPnMEDA6iqQ@mail.gmail.com>
 <65803616-5117-e9f2-ba31-f2f8c323dfe9@php.net>
 <efa9a260-1ce8-a84b-32fc-7cd45454c274@gmx.de>
Message-ID: <b01aec94-9cf4-9281-30ae-f327ce58ea17@php.net>
Date: Wed, 6 May 2020 09:51:42 +0200
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:68.0) Gecko/20100101
 Thunderbird/68.7.0
MIME-Version: 1.0
In-Reply-To: <efa9a260-1ce8-a84b-32fc-7cd45454c274@gmx.de>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Language: pl
Content-Transfer-Encoding: 8bit
X-Posted-By: 83.5.215.81
Subject: Re: [RFC] Named arguments
 Nikita Popov <nikita.ppv@gmail.com>
From: sobak@php.net (Maciej Sobaczewski)

W dniu 06.05.2020 o 09:43, Christoph M. Becker pisze:
> On 06.05.2020 at 08:25, Maciej Sobaczewski wrote:
> 
>> I'm on the fence when it comes to the feature itself so I will skip that
>> part entirerly but I'd like to draw attention to one more problem. Many
>> PHP Manual translations translate the parameter names, too - both in
>> text, as well as in the function/method signatures themselves.
>>
>> We would need to fix every such occurence for every language (at least
>> active ones but there are still couple of them). Otherwise documentation
>> will become highly misleading.
>>
>> Most people probably use IDEs of course but it still doesn't change the
>> fact that the manual cannot be totally out of sync with what could
>> become the language syntax.
> 
> I hope that we will be able to generate the <methodsynopsis> elements
> automatically from the stubs (which would likely require some more
> meta-information in the doc blocks).  These could then automatically be
> injected into the docs.  Of course, someone would have to contribute the
> required scripts. :)
> 
> --
> Christoph M. Becker
> 

That would surely simplify things but that's just the part of the job to
do. There are also inline mentions. Of course, they are wrapped in
<parameter> so we could try to convert them, too but this could be a bit
error prone IMO and probably would make documentation a bit unreadable
if you e.g. inject an English word in the middle of German/Polish
sentence.

Of course this should not be a blocker if the internals will decide that
we want the named parameters. I'm not trying to stop the movement here.
It's simply one more thing to consider :)

Cheers,
Maciej