Skip to content

docs: document unfolds - #1028

Open
matclim wants to merge 1 commit into
Framework-R-D:mainfrom
matclim:docs/unfolds
Open

matclim wants to merge 1 commit into
Framework-R-D:mainfrom
matclim:docs/unfolds

Conversation

@matclim

@matclim matclim commented Nov 1, 2026

Copy link
Copy Markdown
Contributor

The unfold contract is only visible in the implementation and tests. Add a user-guide page that explains:

Also add a Doxygen description of graph_proxy::unfold, and point api/graph_proxy.rst at phlex::detail::graph_proxy, where the class actually lives, so its documentation is rendered.

Assisted by: Claude Haiku 5.5

The unfold contract is only visible in the implementation and tests.  Add
a user-guide page that explains:

- the unfolder class, initial_value(), and the predicate/unfold loop,
  including the accepted callable forms and the optional child
  data_cell_index argument
- per-parent calls, child numbering, empty parents, and why there is no
  way to skip a candidate
- that all input selectors must name the same layer (rejected since
  v0.4.3, see issue Framework-R-D#955) and the transform-then-unfold workaround
- where resource<T>{} arguments go (issue Framework-R-D#946)

Also add a Doxygen description of graph_proxy::unfold, and point
api/graph_proxy.rst at phlex::detail::graph_proxy, where the class
actually lives, so its documentation is rendered.

Assisted by: Claude Haiku 5.5
@coderabbitai

coderabbitai Bot commented Nov 1, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 58 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 9efb4135-2fc9-43eb-8a3d-17dd1148d8cd
Commits

Reviewing files that changed from the base of the PR and between ce771e1 and c1f76ce.

Files selected for processing: 3
  • docs/source/api/graph_proxy.rst
  • docs/source/guide/unfolds.rst
  • phlex/core/graph_proxy.hpp
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@codecov

codecov Bot commented Nov 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@            Coverage Diff             @@
##             main    #1028      +/-   ##
==========================================
- Coverage   89.65%   89.50%   -0.16%     
==========================================
  Files         177      177              
  Lines        5996     5996              
  Branches      994      994              
==========================================
- Hits         5376     5367       -9     
- Misses        392      399       +7     
- Partials      228      230       +2     
Flag Coverage Δ
amd64 89.50% <ø> (-0.16%) ⬇️
arm64 89.50% <ø> (-0.16%) ⬇️

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

Files with missing lines Coverage Δ
phlex/core/graph_proxy.hpp 100.00% <ø> (ø)

... and 2 files with indirect coverage changes


Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ce771e1...c1f76ce. Read the comment docs.

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

This branch has not been deployed

No deployments
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