Improving Javadocs

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Improving Javadocs

Kent Murra
Does improving Javadocs require a JIRA or should I submit as a hotfix?

In particular, I find the Javadocs for RichFunction.open and
RichFunction.close a bit too sparse since it doesn't give a lot of
information on when open and close are called and where (task nodes vs
application driver), and it'd be beneficial for users to elaborate.
Reply | Threaded
Open this post in threaded view
|

Re: Improving Javadocs

Bowen Li
Hi Kent, A “[hotfix]” should be enough

Sent from my iPhone

> On Oct 20, 2017, at 1:58 AM, Kent Murra <[hidden email]> wrote:
>
> Does improving Javadocs require a JIRA or should I submit as a hotfix?
>
> In particular, I find the Javadocs for RichFunction.open and
> RichFunction.close a bit too sparse since it doesn't give a lot of
> information on when open and close are called and where (task nodes vs
> application driver), and it'd be beneficial for users to elaborate.
Reply | Threaded
Open this post in threaded view
|

Re: Improving Javadocs

Aljoscha Krettek-2
The problem with that is that simple hotfix PRs are sometimes not noticed (at least by me). My workflow is roughly:

 - scan every "Jira Issue created" mail
 - "watch" those that I find interesting/important
 - monitor mail on the "watched" issues and react if necessary

I don't have a stream of opened PRs that I monitor.

With this I would notice a Jira issue being created for "Improve Javadoc of RichFunction", I would monitor it and then also see the open PR and probably merge it.

But that's maybe just me.

Best,
Aljoscha

> On 20. Oct 2017, at 02:28, Bowen Li <[hidden email]> wrote:
>
> Hi Kent, A “[hotfix]” should be enough
>
> Sent from my iPhone
>
>> On Oct 20, 2017, at 1:58 AM, Kent Murra <[hidden email]> wrote:
>>
>> Does improving Javadocs require a JIRA or should I submit as a hotfix?
>>
>> In particular, I find the Javadocs for RichFunction.open and
>> RichFunction.close a bit too sparse since it doesn't give a lot of
>> information on when open and close are called and where (task nodes vs
>> application driver), and it'd be beneficial for users to elaborate.