Skip to content

Drop stale doc references#370

Merged
mtfishman merged 2 commits into
mainfrom
mf/drop-visualize-indsnetwork-doc
May 13, 2026
Merged

Drop stale doc references#370
mtfishman merged 2 commits into
mainfrom
mf/drop-visualize-indsnetwork-doc

Conversation

@mtfishman
Copy link
Copy Markdown
Member

@mtfishman mtfishman commented May 12, 2026

Summary

Doc-only cleanup: remove references in docs/src/experimental_methods.md and docs/src/developer_methods.md to methods that no longer exist in src/.

  • visualize(is::IndsNetwork, args...; kwargs...) — removed from src/indsnetwork.jl in #356 along with the IndsNetwork-based ITensorNetwork constructor family. The doc entry was missed.
  • data_graph_type — was an accessor for the pre-#365 DataGraph-based storage layout. After Add reverse Index map to ITensorNetwork; drop preserve_graph and fix_edges! #365 inlined storage into NamedGraph + Dictionary fields, no implementation remains in src/, but the docs still listed it for AbstractFormNetwork, QuadraticFormNetwork, AbstractBeliefPropagationCache, AbstractTTN (as a prose label), and TreeTensorNetwork. Drop all of those entries.
  • edge_data_eltype(::Type{<:AbstractIndsNetwork}) — misnamed; the actual function is DataGraphs.edge_data_type. Fix the name.
  • setindex!(bpc, factor, vertex) — documented for both AbstractBeliefPropagationCache and BeliefPropagationCache, but neither type has a corresponding method in src/. Drop both entries.

No version bump — substantive change accumulates against the existing 0.22.0-DEV prerelease.

The function was removed from src/indsnetwork.jl in #356 along with the
IndsNetwork-based ITensorNetwork constructor family, but this entry in
docs/src/experimental_methods.md was missed.
@codecov
Copy link
Copy Markdown

codecov Bot commented May 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.77%. Comparing base (d02f10e) to head (5b4d02e).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #370   +/-   ##
=======================================
  Coverage   76.77%   76.77%           
=======================================
  Files          57       57           
  Lines        2631     2631           
=======================================
  Hits         2020     2020           
  Misses        611      611           
Flag Coverage Δ
docs 52.43% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 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.

…tindex!(bpc, ...)

`data_graph_type` was an accessor in the pre-#365 DataGraph-based
storage layout. After #365 inlined storage into NamedGraph +
Dictionary fields, no implementation of `data_graph_type` remains
in src/, but the docs still listed it for `AbstractFormNetwork`,
`QuadraticFormNetwork`, `AbstractBeliefPropagationCache`,
`AbstractTTN` (as a prose label), and `TreeTensorNetwork`. Drop
all of those entries.

`edge_data_eltype(::Type{<:AbstractIndsNetwork})` was a misnamed
reference — the actual function is `DataGraphs.edge_data_type`.
Fix the name.

`setindex!(bpc, factor, vertex)` is documented for both
`AbstractBeliefPropagationCache` and `BeliefPropagationCache`,
but neither type has a corresponding method in src/. Drop both
entries.
@mtfishman mtfishman changed the title Drop stale visualize(::IndsNetwork) doc entry Drop stale doc references May 13, 2026
@mtfishman mtfishman enabled auto-merge (squash) May 13, 2026 00:16
@mtfishman mtfishman merged commit 0990ac7 into main May 13, 2026
18 checks passed
@mtfishman mtfishman deleted the mf/drop-visualize-indsnetwork-doc branch May 13, 2026 00:38
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