You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sebb <se...@gmail.com> on 2013/03/18 09:51:51 UTC
Re: [jira] [Commented] (DIGESTER-171) Add DefaultThrowingErrorHandler
to Digester API.
On 18 March 2013 08:46, Sebb (JIRA) <ji...@apache.org> wrote:
>
> [ https://issues.apache.org/jira/browse/DIGESTER-171?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13604945#comment-13604945 ]
>
> Sebb commented on DIGESTER-171:
> -------------------------------
>
> bq. * When adding new classes, it is a good practice adding the @since javadoc tag.
I think it's the job of the Commons developer/release manager to
ensure that the correct @since tags are added.
Seems unfair to ask 3rd parties to work out what the next version
number is - and it may change.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [jira] [Commented] (DIGESTER-171) Add DefaultThrowingErrorHandler
to Digester API.
Posted by Simone Tripodi <si...@apache.org>.
> To whatever decision we come here, please let us document it somewhere in
> the wiki...
+ 1
http://people.apache.org/~simonetripodi/
http://simonetripodi.livejournal.com/
http://twitter.com/simonetripodi
http://www.99soft.org/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [jira] [Commented] (DIGESTER-171) Add DefaultThrowingErrorHandler
to Digester API.
Posted by Benedikt Ritter <br...@apache.org>.
2013/3/18 sebb <se...@gmail.com>
> On 18 March 2013 09:17, Jörg Schaible <Jo...@scalaris.com> wrote:
> > Simone Tripodi wrote:
> >
> >> http://people.apache.org/~simonetripodi/
> >> http://simonetripodi.livejournal.com/
> >> http://twitter.com/simonetripodi
> >> http://www.99soft.org/
> >>
> >>
> >> On Mon, Mar 18, 2013 at 9:51 AM, sebb <se...@gmail.com> wrote:
> >>> On 18 March 2013 08:46, Sebb (JIRA) <ji...@apache.org> wrote:
> >>>>
> >>>> [
> >
> https://issues.apache.org/jira/browse/DIGESTER-171?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-
> > tabpanel&focusedCommentId=13604945#comment-13604945
> >>>> [ ]
> >>>>
> >>>> Sebb commented on DIGESTER-171:
> >>>> bq. * When adding new classes, it is a good practice adding the @since
> >>>> javadoc tag.
> >>>
> >>> I think it's the job of the Commons developer/release manager to
> >>> ensure that the correct @since tags are added.
> >>> Seems unfair to ask 3rd parties to work out what the next version
> >>> number is - and it may change.
> >>
> >> The POM always contains the current development version, not a big
> >> deal for contributors, especially if they aim to become committers, to
> >> get familiar with Commons practices.
>
> The POM is not always correct; it defaults to the next minor version.
>
> Sometimes a point release has to be made to fix a regression, and
> sometimes a major release bump is warranted.
>
> So the exact version number is not always known until release preparation.
>
> In fact this happened recently - the @since version numbers had to be
> changed, as the version changed.
>
> > Actually, for my own projects I always add
> >
> > @since upcoming
> >
> > or
> >
> > @deprecated As of upcoming ...
> >
> > When I prepare a release I use a the regular expression "s/(since|As of)
> > (\s+)upcoming/\1\2VERSION/" to set the proper VERSION.
>
> Like it, except I tend to use
>
> @deprecated since 1.2.3
>
> I chose TODO because I have that set up to create a task flag in
> Eclipse (and it is something to do).
> But the exact placeholder is not critical.
>
To whatever decision we come here, please let us document it somewhere in
the wiki...
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>
--
http://people.apache.org/~britter/
http://www.systemoutprintln.de/
http://twitter.com/BenediktRitter
http://github.com/britter
Re: [jira] [Commented] (DIGESTER-171) Add DefaultThrowingErrorHandler
to Digester API.
Posted by sebb <se...@gmail.com>.
On 18 March 2013 09:58, Jörg Schaible <Jo...@scalaris.com> wrote:
> sebb wrote:
>
>> On 18 March 2013 09:17, Jörg Schaible <Jo...@scalaris.com> wrote:
>
> [snip]
>
>>> Actually, for my own projects I always add
>>>
>>> @since upcoming
>>>
>>> or
>>>
>>> @deprecated As of upcoming ...
>>>
>>> When I prepare a release I use a the regular expression "s/(since|As of)
>>> (\s+)upcoming/\1\2VERSION/" to set the proper VERSION.
>>
>> Like it, except I tend to use
>>
>> @deprecated since 1.2.3
>>
>> I chose TODO because I have that set up to create a task flag in
>> Eclipse (and it is something to do).
>> But the exact placeholder is not critical.
>
> Fine with me. The reason for my "As of placeholder ..." pattern is a
> consequence of javadoc, since it prepends automatically "Deprecated. "[1]
> and uses the text of the tag as sentence[2]. Therefore I add in the real
> world a line like:
>
> @deprecated As of TODO use @{link } instead.
>
> IMHO the text should give a direct hint to any developer who tries to
> "update" his code in a pro-active way to newer functionality.
Agreed; I already added that to the Wiki at
http://wiki.apache.org/commons/CodeStyle
Probably need to add a sample usage.
> Looking
> currently at the deprecated stuff of lang[2] it fails such an explanation
> for some deprecated methods.
Now that would be a useful checkstyle rule!
> - Jörg
>
> [1] http://commons.apache.org/proper/commons-
> lang/apidocs/org/apache/commons/lang3/StringUtils.html#chomp(java.lang.String,
> java.lang.String)
> [2] http://commons.apache.org/proper/commons-lang/apidocs/deprecated-
> list.html
>
>
>
> ---------------------------------------------------------------------
> 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: [jira] [Commented] (DIGESTER-171) Add DefaultThrowingErrorHandler to Digester API.
Posted by Jörg Schaible <Jo...@scalaris.com>.
sebb wrote:
> On 18 March 2013 09:17, Jörg Schaible <Jo...@scalaris.com> wrote:
[snip]
>> Actually, for my own projects I always add
>>
>> @since upcoming
>>
>> or
>>
>> @deprecated As of upcoming ...
>>
>> When I prepare a release I use a the regular expression "s/(since|As of)
>> (\s+)upcoming/\1\2VERSION/" to set the proper VERSION.
>
> Like it, except I tend to use
>
> @deprecated since 1.2.3
>
> I chose TODO because I have that set up to create a task flag in
> Eclipse (and it is something to do).
> But the exact placeholder is not critical.
Fine with me. The reason for my "As of placeholder ..." pattern is a
consequence of javadoc, since it prepends automatically "Deprecated. "[1]
and uses the text of the tag as sentence[2]. Therefore I add in the real
world a line like:
@deprecated As of TODO use @{link } instead.
IMHO the text should give a direct hint to any developer who tries to
"update" his code in a pro-active way to newer functionality. Looking
currently at the deprecated stuff of lang[2] it fails such an explanation
for some deprecated methods.
- Jörg
[1] http://commons.apache.org/proper/commons-
lang/apidocs/org/apache/commons/lang3/StringUtils.html#chomp(java.lang.String,
java.lang.String)
[2] http://commons.apache.org/proper/commons-lang/apidocs/deprecated-
list.html
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [jira] [Commented] (DIGESTER-171) Add DefaultThrowingErrorHandler
to Digester API.
Posted by sebb <se...@gmail.com>.
On 18 March 2013 09:17, Jörg Schaible <Jo...@scalaris.com> wrote:
> Simone Tripodi wrote:
>
>> http://people.apache.org/~simonetripodi/
>> http://simonetripodi.livejournal.com/
>> http://twitter.com/simonetripodi
>> http://www.99soft.org/
>>
>>
>> On Mon, Mar 18, 2013 at 9:51 AM, sebb <se...@gmail.com> wrote:
>>> On 18 March 2013 08:46, Sebb (JIRA) <ji...@apache.org> wrote:
>>>>
>>>> [
> https://issues.apache.org/jira/browse/DIGESTER-171?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-
> tabpanel&focusedCommentId=13604945#comment-13604945
>>>> [ ]
>>>>
>>>> Sebb commented on DIGESTER-171:
>>>> bq. * When adding new classes, it is a good practice adding the @since
>>>> javadoc tag.
>>>
>>> I think it's the job of the Commons developer/release manager to
>>> ensure that the correct @since tags are added.
>>> Seems unfair to ask 3rd parties to work out what the next version
>>> number is - and it may change.
>>
>> The POM always contains the current development version, not a big
>> deal for contributors, especially if they aim to become committers, to
>> get familiar with Commons practices.
The POM is not always correct; it defaults to the next minor version.
Sometimes a point release has to be made to fix a regression, and
sometimes a major release bump is warranted.
So the exact version number is not always known until release preparation.
In fact this happened recently - the @since version numbers had to be
changed, as the version changed.
> Actually, for my own projects I always add
>
> @since upcoming
>
> or
>
> @deprecated As of upcoming ...
>
> When I prepare a release I use a the regular expression "s/(since|As of)
> (\s+)upcoming/\1\2VERSION/" to set the proper VERSION.
Like it, except I tend to use
@deprecated since 1.2.3
I chose TODO because I have that set up to create a task flag in
Eclipse (and it is something to do).
But the exact placeholder is not critical.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [jira] [Commented] (DIGESTER-171) Add DefaultThrowingErrorHandler to Digester API.
Posted by Jörg Schaible <Jo...@scalaris.com>.
Simone Tripodi wrote:
> http://people.apache.org/~simonetripodi/
> http://simonetripodi.livejournal.com/
> http://twitter.com/simonetripodi
> http://www.99soft.org/
>
>
> On Mon, Mar 18, 2013 at 9:51 AM, sebb <se...@gmail.com> wrote:
>> On 18 March 2013 08:46, Sebb (JIRA) <ji...@apache.org> wrote:
>>>
>>> [
https://issues.apache.org/jira/browse/DIGESTER-171?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-
tabpanel&focusedCommentId=13604945#comment-13604945
>>> [ ]
>>>
>>> Sebb commented on DIGESTER-171:
>>> bq. * When adding new classes, it is a good practice adding the @since
>>> javadoc tag.
>>
>> I think it's the job of the Commons developer/release manager to
>> ensure that the correct @since tags are added.
>> Seems unfair to ask 3rd parties to work out what the next version
>> number is - and it may change.
>
> The POM always contains the current development version, not a big
> deal for contributors, especially if they aim to become committers, to
> get familiar with Commons practices.
Actually, for my own projects I always add
@since upcoming
or
@deprecated As of upcoming ...
When I prepare a release I use a the regular expression "s/(since|As of)
(\s+)upcoming/\1\2VERSION/" to set the proper VERSION.
Just my 2¢,
Jörg
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [jira] [Commented] (DIGESTER-171) Add DefaultThrowingErrorHandler
to Digester API.
Posted by Simone Tripodi <si...@apache.org>.
http://people.apache.org/~simonetripodi/
http://simonetripodi.livejournal.com/
http://twitter.com/simonetripodi
http://www.99soft.org/
On Mon, Mar 18, 2013 at 9:51 AM, sebb <se...@gmail.com> wrote:
> On 18 March 2013 08:46, Sebb (JIRA) <ji...@apache.org> wrote:
>>
>> [ https://issues.apache.org/jira/browse/DIGESTER-171?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13604945#comment-13604945 ]
>>
>> Sebb commented on DIGESTER-171:
>> bq. * When adding new classes, it is a good practice adding the @since javadoc tag.
>
> I think it's the job of the Commons developer/release manager to
> ensure that the correct @since tags are added.
> Seems unfair to ask 3rd parties to work out what the next version
> number is - and it may change.
The POM always contains the current development version, not a big
deal for contributors, especially if they aim to become committers, to
get familiar with Commons practices.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org