You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2021/09/08 09:03:43 UTC

[GitHub] [flink] JingGe opened a new pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

JingGe opened a new pull request #17196:
URL: https://github.com/apache/flink/pull/17196


   
   ## What is the purpose of the change
   
   This pull request improves the java doc of the seek() method in the @public abstract class FSDataInputStream by fixing the sentence.
   
   
   ## Brief change log
   
     - *Replace "seek" with "seeks" based on the convention*
     - *Add "to the position" before "past the end of the stream" to improve the expression* 
   
   
   ## Verifying this change
   
   This change is a trivial rework / java doc cleanup without any test coverage.
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink] flinkbot edited a comment on pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #17196:
URL: https://github.com/apache/flink/pull/17196#issuecomment-915073209


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "928d8dcbd3b60d2fe1c37603f26298ad269f86b1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=23768",
       "triggerID" : "928d8dcbd3b60d2fe1c37603f26298ad269f86b1",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 928d8dcbd3b60d2fe1c37603f26298ad269f86b1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=23768) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink] flinkbot commented on pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

Posted by GitBox <gi...@apache.org>.
flinkbot commented on pull request #17196:
URL: https://github.com/apache/flink/pull/17196#issuecomment-915073209


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "928d8dcbd3b60d2fe1c37603f26298ad269f86b1",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "928d8dcbd3b60d2fe1c37603f26298ad269f86b1",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 928d8dcbd3b60d2fe1c37603f26298ad269f86b1 UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink] JingGe edited a comment on pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

Posted by GitBox <gi...@apache.org>.
JingGe edited a comment on pull request #17196:
URL: https://github.com/apache/flink/pull/17196#issuecomment-932735416


   > I don't think this _really_ improves the javadocs. By virtue of what a seek does isn't the "position" bit unnecessary?
   
   Thanks for the feedback. IMHO, javadocs is written to help the user understanding the purpose of the method as easier as possible. It took me quite a while to get the author' idea about what "seek past" really means. To be honest, I read the sentence a few times and finally figured out the missing info between the two continuous written verbs "seek" and "past" should be "to the position". Now the idea is why not just took us 1 minute to add this info to make the comment more user friendly and save every user's time a little bit who will read it. Please let me know your thoughts, thanks. 
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink] flinkbot edited a comment on pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #17196:
URL: https://github.com/apache/flink/pull/17196#issuecomment-915073209


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "928d8dcbd3b60d2fe1c37603f26298ad269f86b1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=23768",
       "triggerID" : "928d8dcbd3b60d2fe1c37603f26298ad269f86b1",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 928d8dcbd3b60d2fe1c37603f26298ad269f86b1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=23768) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run azure` re-run the last Azure build
   </details>


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink] flinkbot commented on pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

Posted by GitBox <gi...@apache.org>.
flinkbot commented on pull request #17196:
URL: https://github.com/apache/flink/pull/17196#issuecomment-915057526


   Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
   to review your pull request. We will use this comment to track the progress of the review.
   
   
   ## Automated Checks
   Last check on commit 928d8dcbd3b60d2fe1c37603f26298ad269f86b1 (Wed Sep 08 09:07:48 UTC 2021)
   
   **Warnings:**
    * No documentation files were touched! Remember to keep the Flink docs up to date!
    * **Invalid pull request title: No valid Jira ID provided**
   
   
   <sub>Mention the bot in a comment to re-run the automated checks.</sub>
   ## Review Progress
   
   * ❓ 1. The [description] looks good.
   * ❓ 2. There is [consensus] that the contribution should go into to Flink.
   * ❓ 3. Needs [attention] from.
   * ❓ 4. The change fits into the overall [architecture].
   * ❓ 5. Overall code [quality] is good.
   
   Please see the [Pull Request Review Guide](https://flink.apache.org/contributing/reviewing-prs.html) for a full explanation of the review process.<details>
    The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot approve description` to approve one or more aspects (aspects: `description`, `consensus`, `architecture` and `quality`)
    - `@flinkbot approve all` to approve all aspects
    - `@flinkbot approve-until architecture` to approve everything until `architecture`
    - `@flinkbot attention @username1 [@username2 ..]` to require somebody's attention
    - `@flinkbot disapprove architecture` to remove an approval you gave earlier
   </details>


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink] JingGe closed pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

Posted by GitBox <gi...@apache.org>.
JingGe closed pull request #17196:
URL: https://github.com/apache/flink/pull/17196


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink] flinkbot edited a comment on pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #17196:
URL: https://github.com/apache/flink/pull/17196#issuecomment-915073209


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "928d8dcbd3b60d2fe1c37603f26298ad269f86b1",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=23768",
       "triggerID" : "928d8dcbd3b60d2fe1c37603f26298ad269f86b1",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 928d8dcbd3b60d2fe1c37603f26298ad269f86b1 Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=23768) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink] zentol commented on pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

Posted by GitBox <gi...@apache.org>.
zentol commented on pull request #17196:
URL: https://github.com/apache/flink/pull/17196#issuecomment-915079916


   I don't think this really improves the javadocs.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink] zentol edited a comment on pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

Posted by GitBox <gi...@apache.org>.
zentol edited a comment on pull request #17196:
URL: https://github.com/apache/flink/pull/17196#issuecomment-915079916


   I don't think this _really_ improves the javadocs. By virtue of what a seek does isn't the "position" bit unnecessary?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink] JingGe edited a comment on pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

Posted by GitBox <gi...@apache.org>.
JingGe edited a comment on pull request #17196:
URL: https://github.com/apache/flink/pull/17196#issuecomment-932735416


   > I don't think this _really_ improves the javadocs. By virtue of what a seek does isn't the "position" bit unnecessary?
   
   Thanks for the feedback. IMHO, javadocs is written to help the user understanding the purpose of the method as easier as possible. It took me quite a while to get the author's idea about what "seek past" really means. To be honest, I read the sentence a few times and finally figured out the missing info between the two continuous written verbs "seek" and "past" should be "to the position". Now the idea is why not just took us 1 minute to add this info to make the comment more user friendly and save every user's time a little bit who will read it. Please let me know your thoughts, thanks. 
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink] JingGe commented on pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

Posted by GitBox <gi...@apache.org>.
JingGe commented on pull request #17196:
URL: https://github.com/apache/flink/pull/17196#issuecomment-932735416


   > I don't think this _really_ improves the javadocs. By virtue of what a seek does isn't the "position" bit unnecessary?
   
   Thanks for the feedback. IMHO, javadocs is written more for the user and less for us. It is written to help the user understanding the purpose of the method as easier as possible. It took me quite a while to get the author' idea about what "seek past" really means. To be honest, I read the sentence a few times and finally figure out the missing info between the two continuous written verbs "seek" and "past" should be "to the position". Now the idea is why not just took us 1 minute to add this info to make the comment more user friendly and save every user's time a little bit who will read it. Please let me know your thoughts, thanks. 
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink] JingGe edited a comment on pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

Posted by GitBox <gi...@apache.org>.
JingGe edited a comment on pull request #17196:
URL: https://github.com/apache/flink/pull/17196#issuecomment-932735416


   > I don't think this _really_ improves the javadocs. By virtue of what a seek does isn't the "position" bit unnecessary?
   
   Thanks for the feedback. IMHO, javadocs is written more for the user and less for us. It is written to help the user understanding the purpose of the method as easier as possible. It took me quite a while to get the author' idea about what "seek past" really means. To be honest, I read the sentence a few times and finally figured out the missing info between the two continuous written verbs "seek" and "past" should be "to the position". Now the idea is why not just took us 1 minute to add this info to make the comment more user friendly and save every user's time a little bit who will read it. Please let me know your thoughts, thanks. 
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink] zentol edited a comment on pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

Posted by GitBox <gi...@apache.org>.
zentol edited a comment on pull request #17196:
URL: https://github.com/apache/flink/pull/17196#issuecomment-915079916


   I don't think this _really_ improves the javadocs.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [flink] zentol closed pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

Posted by GitBox <gi...@apache.org>.
zentol closed pull request #17196:
URL: https://github.com/apache/flink/pull/17196


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org