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
--
PHP Internals - PHP Runtime Development Mailing List
To unsubscribe, visit: http://www.php.net/unsub.php
