You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by greghogan <gi...@git.apache.org> on 2017/02/23 21:40:46 UTC

[GitHub] flink pull request #3404: [FLINK-5597] [docs] Improve the LocalClusteringCoe...

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
    
----

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink issue #3404: [FLINK-5597] [docs] Improve the LocalClusteringCoefficien...

Posted by uce <gi...@git.apache.org>.
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.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request #3404: [FLINK-5597] [docs] Improve the LocalClusteringCoe...

Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:

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


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---