Skip to content

doc: document iqb internals#130

Merged
bassosimone merged 20 commits intomainfrom
doc/tutorial
Feb 4, 2026
Merged

doc: document iqb internals#130
bassosimone merged 20 commits intomainfrom
doc/tutorial

Conversation

@bassosimone
Copy link
Collaborator

@bassosimone bassosimone commented Jan 14, 2026

This pull request documents the iqb internals. Most of the documentation consists of Jupyter Notebooks explaining usage and design choices. We also add tests that statically typecheck the notebooks. The intent of adding those tests is making sure that the they are still in sync with the codebase. In turn, that makes them living documentation.

The notebooks that appear in here are the same ones I used in an internal presentation on 2026-01-14. During this presentation, I explained to my colleagues the current design of the iqb codebase.

@codecov-commenter
Copy link

codecov-commenter commented Jan 14, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.18%. Comparing base (32940a5) to head (d6f4482).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #130   +/-   ##
=======================================
  Coverage   99.17%   99.18%           
=======================================
  Files          37       38    +1     
  Lines        2296     2318   +22     
=======================================
+ Hits         2277     2299   +22     
  Misses         19       19           

☔ 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.

@bassosimone bassosimone changed the title Doc/tutorial doc: document iqb internals Feb 4, 2026
@bassosimone bassosimone self-assigned this Feb 4, 2026
@bassosimone bassosimone marked this pull request as ready for review February 4, 2026 15:19
@bassosimone bassosimone merged commit 04278e2 into main Feb 4, 2026
5 checks passed
@bassosimone bassosimone deleted the doc/tutorial branch February 4, 2026 15:24
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