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.

Sign up for GitHub

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

Jump to bottom

[DOC] Better C++ documentation for Louvain, PR, SSSP and BFS #1490

Closed
ChuckHastings opened this issue Mar 29, 2021 · 0 comments · Fixed by #1489
Closed

[DOC] Better C++ documentation for Louvain, PR, SSSP and BFS #1490

ChuckHastings opened this issue Mar 29, 2021 · 0 comments · Fixed by #1489
Assignees
@ChuckHastings
Labels
doc Documentation
Milestone
0.19

Comments

@ChuckHastings
Copy link
Collaborator

We have a need for better C++ documentation, generally.

The python documentation has standard python documentation as well as jupyter notebook examples that demonstrate the use of each algorithm in working python code.

The C++ code has some nominal doxygen documentation for each algorithm, and that's about it.

Louvain, Pagerank, SSSP and BFS have been converted to use the new graph primitives. These seem like good candidates for prototyping a new documentation structure. Assuming this is acceptable we can then use these as a model for creating better documentation for all of the C++ methods as they are migrated to use the new graph primitives.
@ChuckHastings ChuckHastings added ? - Needs Triage Need team to review and classify doc Documentation labels Mar 29, 2021
@ChuckHastings ChuckHastings mentioned this issue Mar 29, 2021
Merged
@BradReesWork BradReesWork removed the ? - Needs Triage Need team to review and classify label Mar 30, 2021
@BradReesWork BradReesWork added this to the 0.19 milestone Mar 30, 2021
rapids-bot bot pushed a commit that referenced this issue Mar 31, 2021
@ChuckHastings
Create C++ documentation (#1489)
daa9622 
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

Authors:
  - Chuck Hastings (https://github.com/ChuckHastings)

Approvers:
  - Rick Ratzel (https://github.com/rlratzel)
  - Brad Rees (https://github.com/BradReesWork)

URL: #1489
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ChuckHastings ChuckHastings

Labels
doc Documentation
Projects
None yet
Milestone
0.19
Development

Successfully merging a pull request may close this issue.

[REVIEW] Create C++ documentation ChuckHastings/cugraph
2 participants
@BradReesWork @ChuckHastings