[GermanHeim]

Description

This PR adds a compact Display summaries and model-aware formatting for SOS, indicator, and GDP reports.

Checklist

• I have updated the documentation accordingly
• I have added tests that cover my changes
• I have run cargo fmt and cargo clippy to ensure code quality
• All default tests pass (cargo test)

[coderabbitai]

No actionable comments were generated in the recent review.

Recent review info

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: Repository UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: 275dd60f-0dde-4e78-bf6f-1256cfde079c

Commits

Reviewing files that changed from the base of the PR and between edf0c21 and 97e6279.

Files selected for processing: 12

• crates/oximo-core/README.md
• crates/oximo-core/src/gdp.rs
• crates/oximo-core/src/lib.rs
• crates/oximo-core/src/reformulation/display.rs
• crates/oximo-core/src/reformulation/indicator.rs
• crates/oximo-core/src/reformulation/inspection.rs
• crates/oximo-core/src/reformulation/mod.rs
• crates/oximo-core/src/reformulation/sos.rs
• crates/oximo-core/tests/generated_inspection.rs
• crates/oximo-core/tests/reformulation_display.rs
• crates/oximo-gdp/README.md
• crates/oximo-gdp/tests/generated_inspection.rs

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

Walkthrough

SOS, indicator, and GDP reformulation reports gain display APIs. SOS and GDP reports also gain generated-variable inspection APIs. Formatting includes report summaries and model-backed details. Tests and README examples cover the new APIs.

Changes: Reformulation report APIs

Layer / File(s)	Summary
Model-aware report formatting crates/oximo-core/src/reformulation/display.rs, crates/oximo-core/src/reformulation/{indicator.rs,sos.rs,mod.rs}, crates/oximo-core/src/lib.rs, crates/oximo-core/src/gdp.rs, crates/oximo-core/tests/reformulation_display.rs, crates/oximo-gdp/tests/generated_inspection.rs	Adds report summaries and model-backed formatting for SOS, indicator, and GDP reports. Detailed output includes source details, generated variables, and generated constraints when present. GDP display checks model ownership. Tests cover formatted output, omitted empty sections, and use with a different model.
Generated-variable inspection crates/oximo-core/src/reformulation/inspection.rs, crates/oximo-core/src/reformulation/sos.rs, crates/oximo-core/src/gdp.rs, crates/oximo-core/tests/generated_inspection.rs, crates/oximo-gdp/tests/generated_inspection.rs, crates/oximo-core/README.md, crates/oximo-gdp/README.md	Adds iterators over borrowed generated-variable entries for SOS and GDP reports. Tests cover ordering, empty reports, model ownership, and unknown IDs. README examples show report display and programmatic inspection.

Priority: Normal

Estimated code review effort: 3 (Moderate) | ~20 minutes

Change: Feature

Possibly related PRs

• oximo-rs/oximo#117: Adds GDP report data for generated variables and rows, which this PR formats and exposes for inspection.

Merge Risk: Minimal · up to 97e62

The report formatting and inspection changes are ready to merge after normal checks.

Pre-merge checks: 4 · 1

Failed checks: 1 warning

Check name	Status	Explanation	Resolution
Docstring Coverage		Docstring coverage is 14.29% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surv…	Write docstrings for the functions missing them to satisfy the coverage threshold.

Passed checks: 4 passed

Check name	Status	Explanation
Title check		The title clearly and concisely describes the main change: improved readability for reformulation reports.
Description check		The description accurately summarizes the changes and includes completed documentation, test, formatting, linting, and default test checklist items. It omits the Changes Made and Related Issues sectio…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Description check

Explanation

The description accurately summarizes the changes and includes completed documentation, test, formatting, linting, and default test checklist items. It omits the Changes Made and Related Issues sections, and it does not address optional solver-specific tests, but the core information is present.

Full details: Docstring Coverage

Explanation

Docstring coverage is 14.29% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 35 functions across 10 files. (2 skipped: 2 unsupported.)

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

Finishing Touches: 💡 1

📝 Generate docstrings: 💡

• Commit to this branch
• Create a new PR

• 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!