You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Sébastien Brisard <se...@m4x.org> on 2011/09/21 06:25:13 UTC

[math] @since tag

Hi,
I'm currently working on MATH-662. So far, I have merged
CholeskyDecomposition and CholeskyDecompositionImpl. My question is
very simple: CholeskyDecomposition exists as an interface since
version 2.0 (as indicated in the current Javadoc), but as a concrete
class since version 3.0 only. Should the @since tag be updated
accordingly?
Thanks,
Sébastien

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [math] @since tag

Posted by Sébastien Brisard <se...@m4x.org>.
Yes, that would be clear enough.
Sébastien

2011/9/21 sebb <se...@gmail.com>:
> Why not just add some text to the tag to explain what has happened?
>
> Something like:
>
> @since 2.0 (changed to concrete class in 3.0)
>
> 2011/9/21 Sébastien Brisard <se...@m4x.org>:
>> Maybe that tag should be removed (drastic... but no possible confusion!).
>> Sébastien
>>
>> 2011/9/21 Gilles Sadowski <gi...@harfang.homelinux.org>:
>>> On Wed, Sep 21, 2011 at 06:25:13AM +0200, Sébastien Brisard wrote:
>>>> Hi,
>>>> I'm currently working on MATH-662. So far, I have merged
>>>> CholeskyDecomposition and CholeskyDecompositionImpl. My question is
>>>> very simple: CholeskyDecomposition exists as an interface since
>>>> version 2.0 (as indicated in the current Javadoc), but as a concrete
>>>> class since version 3.0 only. Should the @since tag be updated
>>>> accordingly?
>>>
>>> In fact, it depends on whether this tag is intended for tracking the
>>> functionality or the implementation.
>>> And either action could be misleading...
>>>
>>>
>>> Regards,
>>> Gilles
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>>> For additional commands, e-mail: dev-help@commons.apache.org
>>>
>>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>> For additional commands, e-mail: dev-help@commons.apache.org
>>
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [math] @since tag

Posted by Sébastien Brisard <se...@m4x.org>.
Done in r1173788.
Sébastien

2011/9/21 Phil Steitz <ph...@gmail.com>:
> On 9/21/11 5:23 AM, sebb wrote:
>> Why not just add some text to the tag to explain what has happened?
>>
>> Something like:
>>
>> @since 2.0 (changed to concrete class in 3.0)
>
> +1
>
> Phil
>>
>> 2011/9/21 Sébastien Brisard <se...@m4x.org>:
>>> Maybe that tag should be removed (drastic... but no possible confusion!).
>>> Sébastien
>>>
>>> 2011/9/21 Gilles Sadowski <gi...@harfang.homelinux.org>:
>>>> On Wed, Sep 21, 2011 at 06:25:13AM +0200, Sébastien Brisard wrote:
>>>>> Hi,
>>>>> I'm currently working on MATH-662. So far, I have merged
>>>>> CholeskyDecomposition and CholeskyDecompositionImpl. My question is
>>>>> very simple: CholeskyDecomposition exists as an interface since
>>>>> version 2.0 (as indicated in the current Javadoc), but as a concrete
>>>>> class since version 3.0 only. Should the @since tag be updated
>>>>> accordingly?
>>>> In fact, it depends on whether this tag is intended for tracking the
>>>> functionality or the implementation.
>>>> And either action could be misleading...
>>>>
>>>>
>>>> Regards,
>>>> Gilles
>>>>
>>>> ---------------------------------------------------------------------
>>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>>>> For additional commands, e-mail: dev-help@commons.apache.org
>>>>
>>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>>> For additional commands, e-mail: dev-help@commons.apache.org
>>>
>>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>> For additional commands, e-mail: dev-help@commons.apache.org
>>
>>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [math] @since tag

Posted by Phil Steitz <ph...@gmail.com>.
On 9/21/11 5:23 AM, sebb wrote:
> Why not just add some text to the tag to explain what has happened?
>
> Something like:
>
> @since 2.0 (changed to concrete class in 3.0)

+1

Phil
>
> 2011/9/21 Sébastien Brisard <se...@m4x.org>:
>> Maybe that tag should be removed (drastic... but no possible confusion!).
>> Sébastien
>>
>> 2011/9/21 Gilles Sadowski <gi...@harfang.homelinux.org>:
>>> On Wed, Sep 21, 2011 at 06:25:13AM +0200, Sébastien Brisard wrote:
>>>> Hi,
>>>> I'm currently working on MATH-662. So far, I have merged
>>>> CholeskyDecomposition and CholeskyDecompositionImpl. My question is
>>>> very simple: CholeskyDecomposition exists as an interface since
>>>> version 2.0 (as indicated in the current Javadoc), but as a concrete
>>>> class since version 3.0 only. Should the @since tag be updated
>>>> accordingly?
>>> In fact, it depends on whether this tag is intended for tracking the
>>> functionality or the implementation.
>>> And either action could be misleading...
>>>
>>>
>>> Regards,
>>> Gilles
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>>> For additional commands, e-mail: dev-help@commons.apache.org
>>>
>>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>> For additional commands, e-mail: dev-help@commons.apache.org
>>
>>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [math] @since tag

Posted by sebb <se...@gmail.com>.
Why not just add some text to the tag to explain what has happened?

Something like:

@since 2.0 (changed to concrete class in 3.0)

2011/9/21 Sébastien Brisard <se...@m4x.org>:
> Maybe that tag should be removed (drastic... but no possible confusion!).
> Sébastien
>
> 2011/9/21 Gilles Sadowski <gi...@harfang.homelinux.org>:
>> On Wed, Sep 21, 2011 at 06:25:13AM +0200, Sébastien Brisard wrote:
>>> Hi,
>>> I'm currently working on MATH-662. So far, I have merged
>>> CholeskyDecomposition and CholeskyDecompositionImpl. My question is
>>> very simple: CholeskyDecomposition exists as an interface since
>>> version 2.0 (as indicated in the current Javadoc), but as a concrete
>>> class since version 3.0 only. Should the @since tag be updated
>>> accordingly?
>>
>> In fact, it depends on whether this tag is intended for tracking the
>> functionality or the implementation.
>> And either action could be misleading...
>>
>>
>> Regards,
>> Gilles
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>> For additional commands, e-mail: dev-help@commons.apache.org
>>
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [math] @since tag

Posted by Sébastien Brisard <se...@m4x.org>.
Maybe that tag should be removed (drastic... but no possible confusion!).
Sébastien

2011/9/21 Gilles Sadowski <gi...@harfang.homelinux.org>:
> On Wed, Sep 21, 2011 at 06:25:13AM +0200, Sébastien Brisard wrote:
>> Hi,
>> I'm currently working on MATH-662. So far, I have merged
>> CholeskyDecomposition and CholeskyDecompositionImpl. My question is
>> very simple: CholeskyDecomposition exists as an interface since
>> version 2.0 (as indicated in the current Javadoc), but as a concrete
>> class since version 3.0 only. Should the @since tag be updated
>> accordingly?
>
> In fact, it depends on whether this tag is intended for tracking the
> functionality or the implementation.
> And either action could be misleading...
>
>
> Regards,
> Gilles
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [math] @since tag

Posted by Gilles Sadowski <gi...@harfang.homelinux.org>.
On Wed, Sep 21, 2011 at 06:25:13AM +0200, Sébastien Brisard wrote:
> Hi,
> I'm currently working on MATH-662. So far, I have merged
> CholeskyDecomposition and CholeskyDecompositionImpl. My question is
> very simple: CholeskyDecomposition exists as an interface since
> version 2.0 (as indicated in the current Javadoc), but as a concrete
> class since version 3.0 only. Should the @since tag be updated
> accordingly?

In fact, it depends on whether this tag is intended for tracking the
functionality or the implementation.
And either action could be misleading...


Regards,
Gilles

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org