Skip to content

Add an Examples page to the docs - #161

Merged
ViralBShah merged 8 commits into
v11from
vs/examples-docs
Oct 27, 2026
Merged

ViralBShah merged 8 commits into
v11from
vs/examples-docs

Conversation

@ViralBShah

Copy link
Copy Markdown
Member

Adds docs/src/examples.md, linked from make.jl. It lists the algorithms in examples/, each with its entry point and input conventions, and shows a few of them (triangle counting, BFS parents, Bellman-Ford) as doctests on a small graph. The doctests include the example files, so they run the real code.

This is stacked on #57: only the last commit (16cd251) is new. Merge #57 first, after which this diff reduces to that one commit.

Verified:

  • Doctests pass on Julia nightly and on 1.13.
  • docs/make.jl passes on 1.13. On nightly it already failed before this change, inside Documenter 0.27.10's HTML writer.

Not covered: the older examples/pagerank.jl and examples/triangle_centrality.jl no longer work with the current API, so they are left off the page.

🤖 Generated with Claude Code

samuel-esp and others added 8 commits October 27, 2026 15:37
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Use `*(A, B, op; mask)`, `Structural`/`Complement` masks and
  `Descriptor(...)` in place of the removed `mul`, `Semirings.*`,
  `Descriptors.*` and `TRIU`/`TRIL` APIs; drop debug prints.
- BFS: use `fill=nothing` so missing entries read as `nothing`, seed the
  frontier with the source index rather than 1 (parents were wrong for
  any source other than 1), and replace `filter` on a GBVector.
- Prim: `argmin` now returns a linear index; the old code relaxed with
  row `u[1]` (always 1) instead of the selected vertex.
- Floyd-Warshall: combine with `eadd` (union) instead of `emul`, and
  return the distance matrix rather than the last outer product.
- K-truss: iterate until the edge count stops changing.
- CDLP: drop the DataStructures dependency and compute the mode of the
  neighbour labels directly.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Turn the `@repl` blocks in index.md, arrays.md, unaryops.md and
binaryops.md into `jldoctest` blocks with outputs generated by
`doctest(...; fix=true)`. Random inputs in arrays.md are replaced with
small deterministic ones. Printed memory sizes and operator pointer
addresses are filtered since they vary across runs and platforms.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
List the algorithms in examples/ with their entry points and input
conventions, and show a few of them as doctests on a small graph.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@codecov

codecov Bot commented Oct 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.87%. Comparing base (7cf693a) to head (16cd251).

Additional details and impacted files
@@            Coverage Diff             @@
##              v11     #161      +/-   ##
==========================================
+ Coverage   65.65%   65.87%   +0.22%     
==========================================
  Files          54       54              
  Lines        4449     4449              
==========================================
+ Hits         2921     2931      +10     
+ Misses       1528     1518      -10     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ViralBShah
ViralBShah merged commit beb3575 into v11 Oct 27, 2026
7 checks passed
@ViralBShah
ViralBShah deleted the vs/examples-docs branch October 27, 2026 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants