Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLINK-5597] [docs] Improve the LocalClusteringCoefficient documentation #3404

Conversation

greghogan
Copy link
Contributor

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.
In addition to going through the list, please provide a meaningful description of your changes.

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

@uce
Copy link
Contributor

uce commented Feb 26, 2017

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.

/**
 * 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.

@greghogan greghogan force-pushed the 5597_improve_the_localclusteringcoefficient_documentation branch from a2d87b2 to 24e7ec1 Compare March 2, 2017 16:05
@asfgit asfgit closed this in cb9e409 Mar 2, 2017
p16i pushed a commit to p16i/flink that referenced this pull request Apr 16, 2017
Update the documentation for Gelly's library methods with improved
algorithm descriptions and explanation of algorithm results.

This closes apache#3404
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants