Skip to content

Fix minor issues found in the 1.0.0 release - #17

Merged
lgamorim merged 3 commits into
masterfrom
feature/graph-library-1.0.1
Jul 17, 2026
Merged

lgamorim merged 3 commits into
masterfrom
feature/graph-library-1.0.1

Conversation

@lgamorim

@lgamorim lgamorim commented Jul 16, 2026 •

Copy link
Copy Markdown
Owner

Summary

1.0.1 patch off the 1.0.0 release: correctness and packaging fixes found after release. No API surface changes.

Correctness

Packaging / docs

  • The NuGet package readme renders the logo again — a Markdown image instead of the bare <img> HTML that NuGet strips — and the package ships a dedicated icon.png. Closes NuGet package readme does not render the logo #15
  • The docs site shows the Graph1x logo in the navbar instead of the DocFX default (_appLogoPath + logo published as a resource; docfx build clean under --warningsAsErrors). Closes Documentation site shows the default DocFX logo #16
  • CI and coverage badges in both READMEs; CI now uploads coverage to Codecov (CODECOV_TOKEN already configured).
  • "How this was built" authorship disclosure in both READMEs.
  • Milestone issue template; version bumped to 1.0.1 with the [1.0.1] CHANGELOG section.

Kept honest as a patch: the 1.0 feature set and test-count wording, no 1.1.0 content.

🤖 Generated with Claude Code

lgamorim and others added 3 commits July 15, 2026 01:56
Ship a 1.0.1 patch off 1.0.0 (no API changes) bundling the fixes and
polish found after release:

- NuGet package readme now renders the logo — a Markdown image instead
  of the bare <img> HTML NuGet strips, packaged as a dedicated icon.png.
- Docs site shows the Graph1x logo in the navbar instead of the default
  DocFX logo.
- Both READMEs gain CI and coverage badges and a "How this was built"
  disclosure; CI now publishes coverage to Codecov.
- Add the milestone issue template.
- Bump the version to 1.0.1 and add the CHANGELOG entry.

Kept at the 1.0 feature set and 830-test count — no 1.1.0 content in a
patch.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Brandes' path counting is only valid when every vertex settles after all
of its shortest-path predecessors. Dijkstra guarantees that for strictly
positive weights, but a zero-weight edge ties predecessor and successor
at the same distance, so the priority queue can settle them in either
order. When the successor won, relaxing the edge hit the settled-neighbor
short circuit and its path count was never added, silently understating
sigma and producing wrong scores.

A graph of n zero-weight middles between one source and one sink, where
each middle provably sits on 1 of n shortest paths, scored [0.5, 0, ...,
0, 0.5] instead of 1/n each: some middles vanished, others inflated 2.5x.

Prefer a loud failure over plausible-looking wrong numbers, which callers
have no way to detect. Correcting sigma alone would not be enough anyway:
the settle order can also place a vertex ahead of its own predecessor,
breaking the invariant the reverse accumulation phase depends on. Proper
zero-weight support needs equal-distance vertices ordered topologically
over the zero-weight subgraph, which is minor-release work; throwing now
keeps that a compatible widening later.

Positive weights are unaffected, as are the hop-count overloads, which
count paths breadth-first and never consult a weight.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Mermaid treats '#' as the introducer of an entity escape, and the
exporter emitted quotes as "#quot;" without escaping '#' itself. Any
label containing a '#' therefore rendered as text the caller never
wrote, and the escaping was not injective: the literal label
'say #quot;hi#quot;' produced output byte-identical to 'say "hi"'.

Escape '#' as '#35;' before the other cases, which makes the class
doc's promise that arbitrary vertex strings are safe actually true.
Quotes still emit '#quot;' directly rather than through the escaper,
so existing output for quoted labels is unchanged.

Labels are export-only, so this was a fidelity bug rather than an
injection one: a forged entity could alter the rendered text but not
break out of its node.

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

codecov Bot commented Jul 16, 2026

Copy link
Copy Markdown

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered ☂️

@lgamorim
lgamorim merged commit eed39a0 into master Jul 17, 2026
5 checks passed
@lgamorim
lgamorim deleted the feature/graph-library-1.0.1 branch July 17, 2026 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant