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

Unclear Description #103

Closed
GeorgesGITHUB opened this issue Nov 18, 2019 · 1 comment · Fixed by #293
Closed

Unclear Description #103

GeorgesGITHUB opened this issue Nov 18, 2019 · 1 comment · Fixed by #293
Labels
package:graphs type-documentation A request to add or improve documentation

Comments

@GeorgesGITHUB
Copy link

GeorgesGITHUB commented Nov 18, 2019 •
edited
Loading

How are you supposed to use this library? The examples don't make it clear what I have to do to start using the library and what functions I have available.
@devoncarew devoncarew transferred this issue from dart-archive/graphs May 23, 2023
@devoncarew devoncarew added package:graphs type-documentation A request to add or improve documentation labels May 23, 2023
mosuem pushed a commit that referenced this issue Aug 13, 2024
@natebosch
Prepare to publish for stable null safety (#103)
606d67e 
Add CI testing on the oldest supported stable SDK.
@natebosch
Copy link
Member

I agree that we could add a bit more example in the README. We won't list all the functions in the readme since that information is best found through the hosted docs.
https://pub.dev/documentation/graphs/latest/graphs/graphs-library.html

natebosch added a commit that referenced this issue Aug 14, 2024
@natebosch
Add examples of calling two algorithms to README
e86b4bd 
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 mentioned this issue Aug 14, 2024
Merged
natebosch added a commit that referenced this issue Aug 14, 2024
@natebosch
Add examples of calling two algorithms to README (#293)
5b15f8b 
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
package:graphs type-documentation A request to add or improve documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add examples of calling two algorithms to README dart-lang/tools
3 participants
@devoncarew @natebosch @GeorgesGITHUB