Re: STH Docs.
| From: | Peter Cowburn | Date: | Wed, 29 Apr 2015 12:59:06 +0000 |
| Subject: | Re: STH Docs. | ||
| References: | 1 2 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969385616@lists.php.net to get a copy of this message | ||
On 28 April 2015 at 06:00, Levi Morrison <levim@php.net> wrote:
> > I am doing some documentation for STH [...]
>
> I just have a few requests:
>
> - Please don't use an abbreviation like STH in the documentation or its
> URL
> - Please don't use the phrase "type hint" anywhere
>
My feeling (since you first mentioned this, last year?) is that we should
leave the naming as it is in the manual. OK, "type hint" is not "correct"
but it is the accepted terminology in use today and for many, many years in
PHP. Everyone knows and uses the term "type hint" and understands what
that means for their PHP code, and I really see nothing other than academic
correctness pushing any change.
>
> Thank you for looking into docs.
>
> Somewhat related to this is adding documentation for return types.
> Possibly they could go into the same page – it depends on where we
> decide to document scalar types.
>