Hi,
The issue of how to use @since annotations recently came up in the
code review. Those are essential for extension developers who want to
target multiple MediaWiki versions with one codebase. I think we
should come up a standard way to use those.
Without further talk, here are some issues we need to agree upon:
1. Should every new class have a @since annotation
2. Should every new function have a @since annotation
3. Should every new method have a @since annotation
4. Should other things have a @since annotation
5. Should we remove @since annotations of methods at some point
I think 1) and 2) are uncontroversial. I think that in 3) having
@since is redundant if the version is the same as in the @since for
the class. For 4) I think the answer should be yes, if it can be
used/accessed by other code. I also think that @since annotations for
versions that are unsupported *can* be removed, but there is no harm
to keep them around.
What are your opinions on these issues, or can you can come up with
other issues related to @since that should be discussed? In short: we
need to agree on a style, document it, stick to it and enforce it on
the code review.
I hope to get a little more comments than my recent request for
comments regarding the Message class naming issues :) There are more
issues besides this one, for example Jeroen has a wishlist [1] of
additions to coding conventions, but let's concentrate on just @since
annotations in this thread.
[1]
https://secure.wikimedia.org/wikipedia/mediawiki/wiki/User:Jeroen_De_Dauw/C…
Thanks,
-Niklas
--
Niklas Laxström