Skip to content

docs: what a vertex holds (edge lists, with example and figure) - #56

Merged
petercorke merged 2 commits into
mainfrom
doc/vertex-details
Oct 12, 2026
Merged

petercorke merged 2 commits into
mainfrom
doc/vertex-details

Conversation

@petercorke

Copy link
Copy Markdown
Owner

Adds a "What a vertex holds" part to the Edges & Vertices page, beside the data-structures diagram.

  • The private lists of a vertex (_edgelist, _inlist) and its _graph back-pointer, and what each graph kind puts in them (an undirected loop is held twice).
  • A worked example (parallel edges e1/e2, e3, loop e4), drawn for both UGraph and DGraph, with the resulting lists per vertex.
  • How the public methods and degrees read those lists.

Every table row was checked against the source and against the example run on both graph kinds.

Docs only; the build has no warnings.

🤖 Generated with Claude Code

Explains the two edge lists of a vertex (_edgelist, _inlist) and how each
graph kind fills them, with a worked example, a drawing of it, the resulting
lists, and how the public methods and degrees read them.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@codecov

codecov Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.41%. Comparing base (b965468) to head (f0ad331).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #56   +/-   ##
=======================================
  Coverage   96.41%   96.41%           
=======================================
  Files           3        3           
  Lines        1339     1339           
=======================================
  Hits         1291     1291           
  Misses         48       48           

☔ 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.

@petercorke
petercorke merged commit 5c64e4b into main Oct 12, 2026
12 checks passed
@petercorke
petercorke deleted the doc/vertex-details branch October 12, 2026 22:54
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.

1 participant