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/10/05 12:20:58 UTC

[GitHub] [flink] JingGe opened a new pull request #17415: [hotfix][Path] Java doc redundancy and code style check clean-up

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


   
   
   ## What is the purpose of the change
   
   Since org.apache.flink.core.fs.Path is a core public interface for the developer to work with the Flink file system. It makes sense to keep the java doc clean and professional. This PR removes the redundant information in the java doc for many methods and remove a code style check warning by the way.
   
   
   ## Brief change log
   
   - clean up the java doc to remove the redundant information.
   - remove an "Unnecessary string length argument" code style check warning of using substring() method.
   
   
   ## Verifying this change
   
   Most part of this change is java doc cleanup without any test coverage. The only code change to remove the style check warning is already covered by existing tests, such as *PathTest*.
   
   ## Documentation
   
     - Does this pull request introduce a new feature? (yes / **no**)
     - If yes, how is the feature documented? (**not applicable** / docs / JavaDocs / not documented)
   


-- 
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] AHeise commented on pull request #17415: [hotfix][Path] Java doc redundancy and code style check clean-up

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


   Discussion on https://lists.apache.org/thread.html/rbf77ef3ccb28b03ed61c8c6eb344dba6e357cb8be4f3ec18e588c6ec%40%3Cdev.flink.apache.org%3E did not yield a clear result. I'd prefer to wait for Java 16 and use the mentioned `{@return}` in these cases.
   
   If you really want to clean up this JavaDoc pattern, it would be best to do it in all user-facing classes to keep it consistent as we usually value consistency the highest.
   
   For now, I'd close this PR. The larger effort probably deserves a Jira ticket.


-- 
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 #17415: [hotfix][Path] Java doc redundancy and code style check clean-up

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "054801264b1e37653ea51f624d9ac64f04413835",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=24772",
       "triggerID" : "054801264b1e37653ea51f624d9ac64f04413835",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 054801264b1e37653ea51f624d9ac64f04413835 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=24772) 
   
   <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 #17415: [hotfix][Path] Java doc redundancy and code style check clean-up

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "054801264b1e37653ea51f624d9ac64f04413835",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "054801264b1e37653ea51f624d9ac64f04413835",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 054801264b1e37653ea51f624d9ac64f04413835 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] flinkbot commented on pull request #17415: [hotfix][Path] Java doc redundancy and code style check clean-up

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


   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 054801264b1e37653ea51f624d9ac64f04413835 (Tue Oct 05 12:23:37 UTC 2021)
   
   **Warnings:**
    * No documentation files were touched! Remember to keep the Flink docs up to date!
   
   
   <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] AHeise closed pull request #17415: [hotfix][Path] Java doc redundancy and code style check clean-up

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


   


-- 
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 #17415: [hotfix][Path] Java doc redundancy and code style check clean-up

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "054801264b1e37653ea51f624d9ac64f04413835",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=24772",
       "triggerID" : "054801264b1e37653ea51f624d9ac64f04413835",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 054801264b1e37653ea51f624d9ac64f04413835 Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=24772) 
   
   <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 edited a comment on pull request #17415: [hotfix][Path] Java doc redundancy and code style check clean-up

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "054801264b1e37653ea51f624d9ac64f04413835",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=24772",
       "triggerID" : "054801264b1e37653ea51f624d9ac64f04413835",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 054801264b1e37653ea51f624d9ac64f04413835 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=24772) 
   
   <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