Uploaded image for project: 'Flink'
  1. Flink
  2. FLINK-5597

Improve the LocalClusteringCoefficient documentation

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Implemented
    • Affects Version/s: 1.3.0
    • Fix Version/s: 1.3.0
    • Component/s: Documentation, Gelly
    • Labels:
      None

      Description

      The LocalClusteringCoefficient usage section should explain what is the algorithm output and how to retrieve the actual local clustering coefficient scores from it.

        Issue Links

          Activity

          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user greghogan opened a pull request:

          https://github.com/apache/flink/pull/3404

          FLINK-5597 [docs] Improve the LocalClusteringCoefficient documentation

          Thanks for contributing to Apache Flink. Before you open your pull request, please take the following check list into consideration.
          If your changes take all of the items into account, feel free to open your pull request. For more information and/or questions please refer to the [How To Contribute guide](http://flink.apache.org/how-to-contribute.html).
          In addition to going through the list, please provide a meaningful description of your changes.

          • [x] General
          • The pull request references the related JIRA issue ("[FLINK-XXX] Jira title text")
          • The pull request addresses only one issue
          • Each commit in the PR has a meaningful commit message (including the JIRA id)
          • [x] Documentation
          • Documentation has been added for new functionality
          • Old documentation affected by the pull request has been updated
          • JavaDoc for public methods has been added
          • [ ] Tests & Build
          • Functionality added by the pull request is covered by tests
          • `mvn clean verify` has been executed successfully locally or a Travis build has passed

          You can merge this pull request into a Git repository by running:

          $ git pull https://github.com/greghogan/flink 5597_improve_the_localclusteringcoefficient_documentation

          Alternatively you can review and apply these changes as the patch at:

          https://github.com/apache/flink/pull/3404.patch

          To close this pull request, make a commit to your master/trunk branch
          with (at least) the following in the commit message:

          This closes #3404



          Show
          githubbot ASF GitHub Bot added a comment - GitHub user greghogan opened a pull request: https://github.com/apache/flink/pull/3404 FLINK-5597 [docs] Improve the LocalClusteringCoefficient documentation Thanks for contributing to Apache Flink. Before you open your pull request, please take the following check list into consideration. If your changes take all of the items into account, feel free to open your pull request. For more information and/or questions please refer to the [How To Contribute guide] ( http://flink.apache.org/how-to-contribute.html ). In addition to going through the list, please provide a meaningful description of your changes. [x] General The pull request references the related JIRA issue (" [FLINK-XXX] Jira title text") The pull request addresses only one issue Each commit in the PR has a meaningful commit message (including the JIRA id) [x] Documentation Documentation has been added for new functionality Old documentation affected by the pull request has been updated JavaDoc for public methods has been added [ ] Tests & Build Functionality added by the pull request is covered by tests `mvn clean verify` has been executed successfully locally or a Travis build has passed You can merge this pull request into a Git repository by running: $ git pull https://github.com/greghogan/flink 5597_improve_the_localclusteringcoefficient_documentation Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/3404.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #3404
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user uce commented on the issue:

          https://github.com/apache/flink/pull/3404

          Changes read well. +1 to merge.

          Small note on JavaDocs and usage of `<br>` tags: I think the common way is to use `<p>` when the paragraph starts.

          ```java
          /**

          • Hyperlink-Induced Topic Search computes two interdependent scores for every
          • vertex in a directed graph. A good "hub" links to good "authorities" and
          • good "authorities" are linked from good "hubs".
          • <p>This algorithm can be configured to terminate either by a limit on the number
          • of iterations, a convergence threshold, or both.
          • <p>http://www.cs.cornell.edu/home/kleinber/auth.pdf
            *
          • @param <K> graph ID type
          • @param <VV> vertex value type
          • @param <EV> edge value type
            */
            public class HITS<K, VV, EV> {}
            ```

          Of course, we don't have a code style . Just wanted to mention it, I don't think that this needs changes with this PR.

          Show
          githubbot ASF GitHub Bot added a comment - Github user uce commented on the issue: https://github.com/apache/flink/pull/3404 Changes read well. +1 to merge. Small note on JavaDocs and usage of `<br>` tags: I think the common way is to use `<p>` when the paragraph starts. ```java /** Hyperlink-Induced Topic Search computes two interdependent scores for every vertex in a directed graph. A good "hub" links to good "authorities" and good "authorities" are linked from good "hubs". <p>This algorithm can be configured to terminate either by a limit on the number of iterations, a convergence threshold, or both. <p> http://www.cs.cornell.edu/home/kleinber/auth.pdf * @param <K> graph ID type @param <VV> vertex value type @param <EV> edge value type */ public class HITS<K, VV, EV> {} ``` Of course, we don't have a code style . Just wanted to mention it, I don't think that this needs changes with this PR.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

          https://github.com/apache/flink/pull/3404

          Show
          githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/flink/pull/3404
          Hide
          greghogan Greg Hogan added a comment -

          Implemented in cb9e409b764f95e07441a0c8da6c24e21bc1564b

          Show
          greghogan Greg Hogan added a comment - Implemented in cb9e409b764f95e07441a0c8da6c24e21bc1564b

            People

            • Assignee:
              greghogan Greg Hogan
              Reporter:
              vkalavri Vasia Kalavri
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development