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

[DOCS] Document Depth First Search (DFS) #57

Closed
bobluppes opened this issue Aug 6, 2023 · 0 comments
Closed

[DOCS] Document Depth First Search (DFS) #57

bobluppes opened this issue Aug 6, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone

Comments

@bobluppes
Copy link
Owner

Documentation Depth First Search (DFS)

The goal of this issue if the improve the documentation of an existing algorithm. This documentation should go into the algorithms section of our docusaurus docs.

More detail on how to build the documentation locally can be found on the wiki.

An existing documentation page exists, which should be extended. The page can be found under docs/docs/algorithms/traversal/depth-first-search.md.

The corresponding algorithm is called depth_first_traverse and can be found under include/graaflib/algorithm/graph_traversal.h.

Documentation Contents

The documentation entry should adhere to the following template:

# [ALGORITHM_NAME]
- A short description of the algorithm, what does it do and in which use cases is it used.
- What are the limitations of the algorithm, does it work on both directed and undirected graphs? Does it consider edge weights, and if yes, does it support negative weights?
- Link to the wikipedia entry on the algorithm.

## Syntax
- A code block with the syntax of the algorithm. This should now include any javadoc comments.
- An explanation of the parameters (including template parameters) and the return type.

## (Optional) See also
- If there are similar algorithms, or we have a slightly different version of the same algorithm, you can link it here.
- If we have an example (found on the example page of the docs) which uses this algorithm, you can link it here.
@bobluppes bobluppes added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Aug 6, 2023
@bobluppes bobluppes added this to the release 1.0.0 milestone Aug 9, 2023
MichaeINeumann pushed a commit to MichaeINeumann/graaf that referenced this issue Aug 15, 2023
MichaeINeumann pushed a commit to MichaeINeumann/graaf that referenced this issue Aug 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant