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

[REVIEW] Create C++ documentation #1489

Merged

Conversation

ChuckHastings
Copy link
Collaborator

@ChuckHastings ChuckHastings commented Mar 29, 2021

Improve the C++ documentation for the following algorithms: Pagerank, SSSP, BFS, and Louvain.

We need, generally, to improve the C++ documentation for cuGraph. This is intended to improve the documentation for the algorithms that have been adapted to use the new graph primitives and will hopefully provide a construct that we can use for updating other C++ documentation.

As we migrate new algorithms to use the new graph primitives over the next several releases we will create documentation for those algorithms as well.

Closes #1490

@ChuckHastings ChuckHastings requested review from a team as code owners March 29, 2021 20:54
@ChuckHastings ChuckHastings reopened this Mar 29, 2021
@ChuckHastings ChuckHastings changed the title Update Louvain documentation [DRAFT] Update Louvain documentation Mar 29, 2021
@BradReesWork BradReesWork added the doc Documentation label Mar 30, 2021
@BradReesWork BradReesWork added this to the 0.19 milestone Mar 30, 2021
@rlratzel rlratzel added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Mar 31, 2021
@ChuckHastings ChuckHastings changed the title [DRAFT] Update Louvain documentation [DRAFT] Create C++ documentation Mar 31, 2021
@ChuckHastings ChuckHastings changed the title [DRAFT] Create C++ documentation [REVIEW] Create C++ documentation Mar 31, 2021
README.md Show resolved Hide resolved
cpp/src/centrality/README.md Show resolved Hide resolved
cpp/src/centrality/README.md Outdated Show resolved Hide resolved
cpp/src/centrality/README.md Outdated Show resolved Hide resolved
cpp/src/centrality/README.md Outdated Show resolved Hide resolved
cpp/src/centrality/README.md Outdated Show resolved Hide resolved
cpp/src/centrality/README.md Outdated Show resolved Hide resolved
cpp/src/community/README.md Outdated Show resolved Hide resolved
@BradReesWork
Copy link
Member

looks good once Rick's comments are resolved

Copy link
Contributor

@rlratzel rlratzel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This is great and I'm looking forward to more of these.

@rlratzel rlratzel removed the improvement Improvement / enhancement to an existing function label Mar 31, 2021
@BradReesWork
Copy link
Member

@gpucibot merge

@rapids-bot rapids-bot bot merged commit daa9622 into rapidsai:branch-0.19 Mar 31, 2021
@ChuckHastings ChuckHastings deleted the doc_louvain_documentation branch July 28, 2021 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Better C++ documentation for Louvain, PR, SSSP and BFS
3 participants