Skip to content

Organise the README as install, example, API sketch and how it works #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ult666666 merged 2 commits into from
Nov 2, 2026
Merged

Organise the README as install, example, API sketch and how it works #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b525e7
Organise the README as install, example, API sketch and how it works
claude Nov 2, 2026
2bbdd86
Keep the data-flow diagram in DESIGN.md
claude Nov 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ All notable changes to this project are documented here. The format follows
- The tail size `ceil(n * (1 - level))` of historical VaR moved to a shared
helper, so single-sample and rolling historical VaR always use the same rule.
Results are unchanged.
- The README is organised as install, one example, an API sketch and how it
works, and its doctests are unchanged. The command-line examples moved to
`docs/CLI.md`, the figures and studies to `docs/EXAMPLES.md`, and the
per-component checks, full limitations and references to `docs/DESIGN.md`.

### Fixed

Expand Down
Loading
Loading