-
Notifications
You must be signed in to change notification settings - Fork 29
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
Add examples of calling two algorithms to README #293
Conversation
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.
PR HealthBreaking changes ✔️Details
Changelog Entry ✔️Details
Changes to files need to be accounted for in their respective changelogs. Coverage ✔️Details
This check for test coverage is informational (issues shown here will not fail the PR). API leaks ✔️DetailsThe following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.
License Headers ✔️Details
All source files should start with a license header. Package publish validation ✔️Details
Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm, but note the two diagnostics from the unintended_html_in_doc_comment
lint
e64e432
to
76c3aea
Compare
Revisions updated by `dart tools/rev_sdk_deps.dart`. dartdoc (https://github.com/dart-lang/dartdoc/compare/ce09815..b444974): b4449742 2024-08-14 Sam Rawlins Add a doc-import into template_data.dart to resolve 'GeneratorBackend.write' (dart-lang/dartdoc#3832) 7fb1f3f3 2024-08-14 Sam Rawlins Fix links in sidebar of extension types (dart-lang/dartdoc#3831) 392e2aa3 2024-08-14 Sam Rawlins Simplify some Container fields only used for sidebar logic. (dart-lang/dartdoc#3834) 31e110d6 2024-08-13 Sam Rawlins Add tests supporting the wildcard feature (dart-lang/dartdoc#3835) ecosystem (https://github.com/dart-lang/ecosystem/compare/2719d0c..8626bff): 8626bff 2024-08-16 Jacob MacDonald More concise formatting of github workflow summary comments (dart-lang/ecosystem#288) de7883c 2024-08-14 Moritz Update PR Health install instructions (dart-lang/ecosystem#286) 03bf029 2024-08-14 Moritz Fix linting (dart-lang/ecosystem#287) http (https://github.com/dart-lang/http/compare/76512c4..b97b8dc): b97b8dc 2024-08-16 Anikate De pkgs/ok_http: OkHttpClientConfiguration and configurable timeouts. (dart-lang/http#1289) 4322382 2024-08-13 Brian Quinlan Fix "unintended_html_in_doc_comment" analysis errors (dart-lang/http#1291) test (https://github.com/dart-lang/test/compare/8be3c94..cd3dbd5): cd3dbd51 2024-08-15 Jacob MacDonald require approval from core-package-admins for anything under /pkgs (dart-lang/test#2268) cfc18ee1 2024-08-14 Jacob MacDonald add health check job (dart-lang/test#2266) f3984a72 2024-08-13 Jacob MacDonald update changelogs per dart-lang/test#2262 (dart-lang/test#2267) tools (https://github.com/dart-lang/tools/compare/d563c38..5b15f8b): 5b15f8b 2024-08-14 Nate Bosch Add examples of calling two algorithms to README (dart-lang/tools#293) ece541c 2024-08-14 Nate Bosch Ignore unintended_html_in_doc_comment (dart-lang/tools#294) Change-Id: I23d2f9606e4bfefdfa61e0a4c629f3f05f00c996 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/381320 Reviewed-by: Nate Bosch <[email protected]> Commit-Queue: Devon Carew <[email protected]>
Closes #103
Reword most of the README.
algorithms.
structures.
callbacks needed.
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 graphwith adjacency lists stored in a
Map
using terms related tonetworking. The other calls
topologicalSort
on a graph represented bya tree of node objects which store outgoing edges using terms related to
build dependencies.