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

Add examples of calling two algorithms to README #293

Merged
merged 3 commits into from
Aug 14, 2024
Merged

Add examples of calling two algorithms to README #293

merged 3 commits into from
Aug 14, 2024

Commits on Aug 14, 2024

  1. Add examples of calling two algorithms to README 

    Closes #103

Reword most of the README.
- Use "callback" consistently to describe the arguments to the
  algorithms.
- Add generics and more specific names to the tiny example data
  structures.
- Use consistent phrasing in the bullet points about the types of
  callbacks needed.
- Reorder the bullet points since the edges callbacks are always used
  and worth mentioning first.

Add a code block with skeleton examples of calls using each of the
example data structures. One example of calls `shortestPath` on a graph
with adjacency lists stored in a `Map` using terms related to
networking. The other calls `topologicalSort` on a graph represented by
a tree of node objects which store outgoing edges using terms related to
build dependencies.
    @natebosch
    natebosch committed Aug 14, 2024
    Configuration menu
    Copy the full SHA
    e86b4bd View commit details
    Browse the repository at this point in the history

  2. Add a comma

    @natebosch
    natebosch committed Aug 14, 2024
    Configuration menu
    Copy the full SHA
    7de6786 View commit details
    Browse the repository at this point in the history

  3. Merge branch 'main' into graphs-readme-example

    @natebosch
    natebosch committed Aug 14, 2024
    Configuration menu
    Copy the full SHA
    76c3aea View commit details
    Browse the repository at this point in the history