Meanwhile, I've encountered another problem that supports the point that we
need to document functions, this or another way: Phan barfs about functions
using Database::selectField().[1] I've suppressed the warnings for now, but
would like a more permanent solution.
-
[1]
https://integration.w
Hey,
Personally I'm not using this in my projects and would object to those tags
being added as they are IMO clutter. Those projects have some relevant
differences with MediaWiki that all contribute to those tags being more
clutter than helpful:
* Good OO: small classes and interfaces, favoring o
On Thursdy, May 18, 2017, Stas Malyshev wrote:
> Hi!
>
>> What are people's opinions on using it?
>
> I think it's OK to use it in relevant cases (along with already existing
> and used @see) and recognize such uses as documented, but making it
> mandatory would look like increasing busywork for a
Hi!
> What are people's opinions on using it?
I think it's OK to use it in relevant cases (along with already existing
and used @see) and recognize such uses as documented, but making it
mandatory would look like increasing busywork for a doubtful benefit of
making robots (e.g. syntax checkers) n
Hi,
On 05/13/2017 03:43 PM, Ryan Kaldari wrote:
> A question that came up during Documentation Day was whether or not we
> should use the @inheritdoc convention for indicating that methods are
> documented in parent classes (rather than leaving them blank).
>
> Some arguments for using it include
On Sun, May 14, 2017 at 12:43 AM, Ryan Kaldari
wrote:
> A question that came up during Documentation Day was whether or not we
> should use the @inheritdoc convention for indicating that methods are
> documented in parent classes (rather than leaving them blank).
>
It would be nice to check comp
Thanks for raising this question, I was thinking about something similar a
little while back when I was reviewing some code without the explicit
@inheritdoc on it.
I personally think we'll gain a lot more if we stick to always documenting
our methods, including @inheritdoc. Reasoning below.
On Sa
A question that came up during Documentation Day was whether or not we
should use the @inheritdoc convention for indicating that methods are
documented in parent classes (rather than leaving them blank).
Some arguments for using it include:
* It can help code-sniffers and linters know that the doc
