Skip to content

Expand README: comparison table, Mermaid architecture diagram, more examples, badge row#402

Merged
tschm merged 10 commits intomainfrom
copilot/expand-readme-add-content
Mar 23, 2026
Merged

Expand README: comparison table, Mermaid architecture diagram, more examples, badge row#402
tschm merged 10 commits intomainfrom
copilot/expand-readme-add-content

Conversation

Copy link
Contributor

Copilot AI commented Mar 23, 2026

  • Reorganise badge row — PyPI version, Python versions, Coverage prominently first
  • Add "⚡ jQuantStats vs QuantStats" comparison table
  • Replace ASCII architecture diagram with Mermaid flowchart TD diagram
  • Add three new full-code Quick Start examples: risk metrics, benchmark comparison, HTML report
  • Fix make validate — corrected examples to use real API (greeks(), to_html()) and assignment style consistent with existing blocks
  • Exclude generated report.html from git via .gitignore
Original prompt

This section details on the original issue you should resolve

<issue_title>Expand README — Add: comparison table vs QuantStats, architecture diagram (Mermaid), more full-code examples, coverage/PyPI/version badges row</issue_title>
<issue_description></issue_description>

Comments on the Issue (you are @copilot in this section)


⌨️ Start Copilot coding agent tasks without leaving your editor — available in VS Code, Visual Studio, JetBrains IDEs and Eclipse.

Copilot AI changed the title [WIP] Expand README by adding comparison table and architecture diagram Expand README: comparison table, Mermaid architecture diagram, more examples, badge row Mar 23, 2026
Copilot AI requested a review from tschm March 23, 2026 10:55
@tschm tschm marked this pull request as ready for review March 23, 2026 10:56
@tschm
Copy link
Owner

tschm commented Mar 23, 2026

@copilot: fix "make validate"

Copy link
Contributor Author

Copilot AI commented Mar 23, 2026

@copilot: fix "make validate"

Fixed in 909bb71. The test_readme_runs test in .rhiza/tests/sync/test_readme_validation.py concatenates and executes all Python code blocks in the README. Three issues were found and fixed:

  1. data.stats.alpha() / data.stats.beta() don't exist — replaced with data.stats.greeks() which returns {"alpha": ..., "beta": ...} per column
  2. pf.report.full() doesn't exist — replaced with pf.report.to_html()
  3. print() statements produced unexpected stdout — replaced with variable assignments consistent with the existing README style

Also added report.html to .gitignore since it gets generated when the test runs the code block.

@tschm tschm merged commit 154547b into main Mar 23, 2026
21 checks passed
@tschm tschm deleted the copilot/expand-readme-add-content branch March 23, 2026 11:42
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.

Expand README — Add: comparison table vs QuantStats, architecture diagram (Mermaid), more full-code examples, coverage/PyPI/version badges row

2 participants