You are viewing a plain text version of this content. The canonical link for it is here.

Posted to user@flink.apache.org by makeyang <ri...@hotmail.com> on 2018/05/31 09:40:09 UTC

is it OK to PR just for code comment errors?

I am not sure if it is OK to PR just for code comment errors since I found
there is one when I am reading code



--
Sent from: http://apache-flink-user-mailing-list-archive.2336050.n4.nabble.com/

Re: is it OK to PR just for code comment errors?

Posted by Rong Rong <wa...@gmail.com>.

Hi Makeyang,

It is definitely OK to open a PR for correcting code comment errors.
Especially for the ones that are misleading or provide incorrect
information to users.

I am not sure if it is required if only for a one-liner change, but please
file a JIRA ticket for the code comment error as well.

Thanks,
Rong

On Thu, May 31, 2018 at 2:40 AM, makeyang <ri...@hotmail.com> wrote:

> I am not sure if it is OK to PR just for code comment errors since I found
> there is one when I am reading code
>
>
>
> --
> Sent from: http://apache-flink-user-mailing-list-archive.2336050.
> n4.nabble.com/
>

Re: is it OK to PR just for code comment errors?

Posted by makeyang <ri...@hotmail.com>.

got it. 
thanks guys



--
Sent from: http://apache-flink-user-mailing-list-archive.2336050.n4.nabble.com/

Re: is it OK to PR just for code comment errors?

Posted by Shuyi Chen <su...@gmail.com>.

I think this is classified as "hotifx" in the contributor list, no JIRA
should be needed.

*" Typo fixes that have no associated JIRA issue should be named following
this pattern: `[hotfix] [docs] Fix typo in event time introduction` or
`[hotfix] [javadocs] Expand JavaDoc for PuncuatedWatermarkGenerator`."*


On Thu, May 31, 2018 at 7:54 AM, Chesnay Schepler <ch...@apache.org>
wrote:

> For typos in the documentation or javadocs feel free to open a PR.
>
> I would leave code comments alone as long as the typo doesn't affect the
> clarity/semantics of the comment,
> to not fragment the git history unnecessarily.
>
>
> On 31.05.2018 11:40, makeyang wrote:
>
>> I am not sure if it is OK to PR just for code comment errors since I found
>> there is one when I am reading code
>>
>>
>>
>> --
>> Sent from: http://apache-flink-user-mailing-list-archive.2336050.n4.
>> nabble.com/
>>
>>
>


-- 
"So you have to trust that the dots will somehow connect in your future."

Re: is it OK to PR just for code comment errors?

Posted by Rong Rong <wa...@gmail.com>.

Yes, Chesnay was right if the error code comment doesn't affect the clarity
of the message. Sorry for the confusion.

--
Rong

On Thu, May 31, 2018 at 7:54 AM, Chesnay Schepler <ch...@apache.org>
wrote:

> For typos in the documentation or javadocs feel free to open a PR.
>
> I would leave code comments alone as long as the typo doesn't affect the
> clarity/semantics of the comment,
> to not fragment the git history unnecessarily.
>
>
> On 31.05.2018 11:40, makeyang wrote:
>
>> I am not sure if it is OK to PR just for code comment errors since I found
>> there is one when I am reading code
>>
>>
>>
>> --
>> Sent from: http://apache-flink-user-mailing-list-archive.2336050.n4.
>> nabble.com/
>>
>>
>

Re: is it OK to PR just for code comment errors?

Posted by Chesnay Schepler <ch...@apache.org>.

For typos in the documentation or javadocs feel free to open a PR.

I would leave code comments alone as long as the typo doesn't affect the 
clarity/semantics of the comment,
to not fragment the git history unnecessarily.

On 31.05.2018 11:40, makeyang wrote:
> I am not sure if it is OK to PR just for code comment errors since I found
> there is one when I am reading code
>
>
>
> --
> Sent from: http://apache-flink-user-mailing-list-archive.2336050.n4.nabble.com/
>