DOCS: Add ARCHITECTURE.md. by genedan · Pull Request #1070 · casact/chainladder-python

genedan · 2026-06-29T01:41:36Z

Summary of Changes

I asked Claude to write this up, because there was no way I was going to draw that tree manually.

Related GitHub Issue(s)

Additional Context for Reviewers

GitHub-rendered Markdown can be viewed at:

https://github.com/casact/chainladder-python/blob/3fb2ac47ee290b7d3f1de7df3f2ac25b1a806f88/ARCHITECTURE.md

Let me know what you think of the level of jargon in this file, and whether you think an interested contributor would understand it. I had to do a lot of googling of the terms. I expanded acronyms and added clarifying text.

For example a sentence like:

Triangle is assembled from a stack of single-responsibility mixins. Python resolves methods left-to-right across the MRO (method resolution order), so the order in TriangleBase determines which mixin wins on any name collision.

Could be written in plainer English if we expanded it to be a few paragraphs. After googling terms like "single-responsibility" and "MRO", I decided I was mostly satisfied with these explanations, so I didn't replace the jargon.

I passed tests locally for both code (uv run pytest) and documentation changes (uv run jb build docs --builder=custom --custom-builder=doctest)

Note

Low Risk
Documentation-only change with no runtime or API impact.

Overview
Introduces ARCHITECTURE.md at the repo root as onboarding documentation for contributors (issue #1004).

The doc maps the chainladder/ tree (core, development, tails, methods, adjustments, workflow, utils) with short notes on what each module owns. It explains how Triangle is built from mixins via TriangleBase and MRO order, how .loc / .iloc accessors are composed through TriangleSlicer._set_slicers, and documents the TYPE_CHECKING + TriangleProtocol pattern for mixin typing without runtime MRO conflicts. A second section sketches sklearn-style inheritance for development, tail, reserve, adjustment, and workflow estimators.

No application code, tests, or build config are modified—documentation only.

^{Reviewed by Cursor Bugbot for commit c630bc8. Bugbot is set up for automated code reviews on this repo. Configure here.}

codecov · 2026-06-29T01:42:01Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.73%. Comparing base (e5594da) to head (c630bc8).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #1070 +/- ##
==========================================
+ Coverage 89.38% 90.73% +1.35% 
==========================================
Files 89 91 +2 Lines 5179 5970 +791 Branches 663 873 +210 ==========================================
+ Hits 4629 5417 +788 
Misses 386 386 - Partials 164 167 +3

Flag	Coverage Δ
unittests	`90.70% <ø> (+1.32%)`	⬆️

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

☔ View full report in Codecov by Harness.
📢 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.

github-actions · 2026-06-29T01:42:29Z

Pyright Type Completeness

View the full pyright --verifytypes output for this commit

Project (full chainladder package, at this PR's head): 13.5% of exported symbols fully typed (163 / 1209)

	Known	Ambiguous	Unknown	Total
Project (head)	163	107	939	1209

Other symbols referenced but not exported by chainladder: 13

	Known	Ambiguous	Unknown	Total
Other (head)	3	1	9	13

Symbols without documentation:

Functions without docstring: 315
Functions without default param: 0
Classes without docstring: 10

Patch (exported symbols added or changed by this PR): no exported symbol type-completeness changes detected.

henrydingliu · 2026-06-29T02:49:03Z

thank you so much for this!! just one gripe.

genedan · 2026-06-29T01:41:36Z

Summary of Changes

I asked Claude to write this up, because there was no way I was going to draw that tree manually.

Related GitHub Issue(s)

#1004

Additional Context for Reviewers

GitHub-rendered Markdown can be viewed at:

https://github.com/casact/chainladder-python/blob/3fb2ac47ee290b7d3f1de7df3f2ac25b1a806f88/ARCHITECTURE.md

Let me know what you think of the level of jargon in this file, and whether you think an interested contributor would understand it. I had to do a lot of googling of the terms. I expanded acronyms and added clarifying text.

For example a sentence like:

Triangle is assembled from a stack of single-responsibility mixins. Python resolves methods left-to-right across the MRO (method resolution order), so the order in TriangleBase determines which mixin wins on any name collision.

Could be written in plainer English if we expanded it to be a few paragraphs. After googling terms like "single-responsibility" and "MRO", I decided I was mostly satisfied with these explanations, so I didn't replace the jargon.

I passed tests locally for both code (uv run pytest) and documentation changes (uv run jb build docs --builder=custom --custom-builder=doctest)

Note

Low Risk
Documentation-only change with no runtime or API impact.

Overview
Introduces ARCHITECTURE.md at the repo root as onboarding documentation for contributors (issue #1004).

The doc maps the chainladder/ tree (core, development, tails, methods, adjustments, workflow, utils) with short notes on what each module owns. It explains how Triangle is built from mixins via TriangleBase and MRO order, how .loc / .iloc accessors are composed through TriangleSlicer._set_slicers, and documents the TYPE_CHECKING + TriangleProtocol pattern for mixin typing without runtime MRO conflicts. A second section sketches sklearn-style inheritance for development, tail, reserve, adjustment, and workflow estimators.

No application code, tests, or build config are modified—documentation only.

^{Reviewed by Cursor Bugbot for commit c630bc8. Bugbot is set up for automated code reviews on this repo. Configure here.}

codecov · 2026-06-29T01:42:01Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.73%. Comparing base (e5594da) to head (c630bc8).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #1070 +/- ##
==========================================
+ Coverage 89.38% 90.73% +1.35% 
==========================================
Files 89 91 +2 Lines 5179 5970 +791 Branches 663 873 +210 ==========================================
+ Hits 4629 5417 +788 
Misses 386 386 - Partials 164 167 +3

Flag	Coverage Δ
unittests	`90.70% <ø> (+1.32%)`	⬆️

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

☔ View full report in Codecov by Harness.
📢 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.

github-actions · 2026-06-29T01:42:29Z

Pyright Type Completeness

View the full pyright --verifytypes output for this commit

Project (full chainladder package, at this PR's head): 13.5% of exported symbols fully typed (163 / 1209)

	Known	Ambiguous	Unknown	Total
Project (head)	163	107	939	1209

Other symbols referenced but not exported by chainladder: 13

	Known	Ambiguous	Unknown	Total
Other (head)	3	1	9	13

Symbols without documentation:

Functions without docstring: 315
Functions without default param: 0
Classes without docstring: 10

Patch (exported symbols added or changed by this PR): no exported symbol type-completeness changes detected.

henrydingliu · 2026-06-29T02:49:03Z

thank you so much for this!! just one gripe.

genedan · 2026-06-29T01:41:36Z

Summary of Changes

I asked Claude to write this up, because there was no way I was going to draw that tree manually.

Related GitHub Issue(s)

#1004

Additional Context for Reviewers

GitHub-rendered Markdown can be viewed at:

https://github.com/casact/chainladder-python/blob/3fb2ac47ee290b7d3f1de7df3f2ac25b1a806f88/ARCHITECTURE.md

Let me know what you think of the level of jargon in this file, and whether you think an interested contributor would understand it. I had to do a lot of googling of the terms. I expanded acronyms and added clarifying text.

For example a sentence like:

Triangle is assembled from a stack of single-responsibility mixins. Python resolves methods left-to-right across the MRO (method resolution order), so the order in TriangleBase determines which mixin wins on any name collision.

Could be written in plainer English if we expanded it to be a few paragraphs. After googling terms like "single-responsibility" and "MRO", I decided I was mostly satisfied with these explanations, so I didn't replace the jargon.

I passed tests locally for both code (uv run pytest) and documentation changes (uv run jb build docs --builder=custom --custom-builder=doctest)

Note

Low Risk
Documentation-only change with no runtime or API impact.

Overview
Introduces ARCHITECTURE.md at the repo root as onboarding documentation for contributors (issue #1004).

The doc maps the chainladder/ tree (core, development, tails, methods, adjustments, workflow, utils) with short notes on what each module owns. It explains how Triangle is built from mixins via TriangleBase and MRO order, how .loc / .iloc accessors are composed through TriangleSlicer._set_slicers, and documents the TYPE_CHECKING + TriangleProtocol pattern for mixin typing without runtime MRO conflicts. A second section sketches sklearn-style inheritance for development, tail, reserve, adjustment, and workflow estimators.

No application code, tests, or build config are modified—documentation only.

^{Reviewed by Cursor Bugbot for commit c630bc8. Bugbot is set up for automated code reviews on this repo. Configure here.}

codecov · 2026-06-29T01:42:01Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.73%. Comparing base (e5594da) to head (c630bc8).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #1070 +/- ##
==========================================
+ Coverage 89.38% 90.73% +1.35% 
==========================================
Files 89 91 +2 Lines 5179 5970 +791 Branches 663 873 +210 ==========================================
+ Hits 4629 5417 +788 
Misses 386 386 - Partials 164 167 +3

Flag	Coverage Δ
unittests	`90.70% <ø> (+1.32%)`	⬆️

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

☔ View full report in Codecov by Harness.
📢 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.

github-actions · 2026-06-29T01:42:29Z

Pyright Type Completeness

View the full pyright --verifytypes output for this commit

Project (full chainladder package, at this PR's head): 13.5% of exported symbols fully typed (163 / 1209)

	Known	Ambiguous	Unknown	Total
Project (head)	163	107	939	1209

Other symbols referenced but not exported by chainladder: 13

	Known	Ambiguous	Unknown	Total
Other (head)	3	1	9	13

Symbols without documentation:

Functions without docstring: 315
Functions without default param: 0
Classes without docstring: 10

Patch (exported symbols added or changed by this PR): no exported symbol type-completeness changes detected.

henrydingliu · 2026-06-29T02:49:03Z

thank you so much for this!! just one gripe.

genedan · 2026-06-29T01:41:36Z

Summary of Changes

I asked Claude to write this up, because there was no way I was going to draw that tree manually.

Related GitHub Issue(s)

#1004

Additional Context for Reviewers

GitHub-rendered Markdown can be viewed at:

https://github.com/casact/chainladder-python/blob/3fb2ac47ee290b7d3f1de7df3f2ac25b1a806f88/ARCHITECTURE.md

Let me know what you think of the level of jargon in this file, and whether you think an interested contributor would understand it. I had to do a lot of googling of the terms. I expanded acronyms and added clarifying text.

For example a sentence like:

Triangle is assembled from a stack of single-responsibility mixins. Python resolves methods left-to-right across the MRO (method resolution order), so the order in TriangleBase determines which mixin wins on any name collision.

Could be written in plainer English if we expanded it to be a few paragraphs. After googling terms like "single-responsibility" and "MRO", I decided I was mostly satisfied with these explanations, so I didn't replace the jargon.

I passed tests locally for both code (uv run pytest) and documentation changes (uv run jb build docs --builder=custom --custom-builder=doctest)

Note

Low Risk
Documentation-only change with no runtime or API impact.

Overview
Introduces ARCHITECTURE.md at the repo root as onboarding documentation for contributors (issue #1004).

The doc maps the chainladder/ tree (core, development, tails, methods, adjustments, workflow, utils) with short notes on what each module owns. It explains how Triangle is built from mixins via TriangleBase and MRO order, how .loc / .iloc accessors are composed through TriangleSlicer._set_slicers, and documents the TYPE_CHECKING + TriangleProtocol pattern for mixin typing without runtime MRO conflicts. A second section sketches sklearn-style inheritance for development, tail, reserve, adjustment, and workflow estimators.

No application code, tests, or build config are modified—documentation only.

^{Reviewed by Cursor Bugbot for commit c630bc8. Bugbot is set up for automated code reviews on this repo. Configure here.}

codecov · 2026-06-29T01:42:01Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.73%. Comparing base (e5594da) to head (c630bc8).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #1070 +/- ##
==========================================
+ Coverage 89.38% 90.73% +1.35% 
==========================================
Files 89 91 +2 Lines 5179 5970 +791 Branches 663 873 +210 ==========================================
+ Hits 4629 5417 +788 
Misses 386 386 - Partials 164 167 +3

Flag	Coverage Δ
unittests	`90.70% <ø> (+1.32%)`	⬆️

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

☔ View full report in Codecov by Harness.
📢 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.

github-actions · 2026-06-29T01:42:29Z

Pyright Type Completeness

View the full pyright --verifytypes output for this commit

Project (full chainladder package, at this PR's head): 13.5% of exported symbols fully typed (163 / 1209)

	Known	Ambiguous	Unknown	Total
Project (head)	163	107	939	1209

Other symbols referenced but not exported by chainladder: 13

	Known	Ambiguous	Unknown	Total
Other (head)	3	1	9	13

Symbols without documentation:

Functions without docstring: 315
Functions without default param: 0
Classes without docstring: 10

Patch (exported symbols added or changed by this PR): no exported symbol type-completeness changes detected.

henrydingliu · 2026-06-29T02:49:03Z

thank you so much for this!! just one gripe.

genedan · 2026-06-29T01:41:36Z

Summary of Changes

I asked Claude to write this up, because there was no way I was going to draw that tree manually.

Related GitHub Issue(s)

#1004

Additional Context for Reviewers

GitHub-rendered Markdown can be viewed at:

https://github.com/casact/chainladder-python/blob/3fb2ac47ee290b7d3f1de7df3f2ac25b1a806f88/ARCHITECTURE.md

Let me know what you think of the level of jargon in this file, and whether you think an interested contributor would understand it. I had to do a lot of googling of the terms. I expanded acronyms and added clarifying text.

For example a sentence like:

Triangle is assembled from a stack of single-responsibility mixins. Python resolves methods left-to-right across the MRO (method resolution order), so the order in TriangleBase determines which mixin wins on any name collision.

Could be written in plainer English if we expanded it to be a few paragraphs. After googling terms like "single-responsibility" and "MRO", I decided I was mostly satisfied with these explanations, so I didn't replace the jargon.

I passed tests locally for both code (uv run pytest) and documentation changes (uv run jb build docs --builder=custom --custom-builder=doctest)

Note

Low Risk
Documentation-only change with no runtime or API impact.

Overview
Introduces ARCHITECTURE.md at the repo root as onboarding documentation for contributors (issue #1004).

The doc maps the chainladder/ tree (core, development, tails, methods, adjustments, workflow, utils) with short notes on what each module owns. It explains how Triangle is built from mixins via TriangleBase and MRO order, how .loc / .iloc accessors are composed through TriangleSlicer._set_slicers, and documents the TYPE_CHECKING + TriangleProtocol pattern for mixin typing without runtime MRO conflicts. A second section sketches sklearn-style inheritance for development, tail, reserve, adjustment, and workflow estimators.

No application code, tests, or build config are modified—documentation only.

^{Reviewed by Cursor Bugbot for commit c630bc8. Bugbot is set up for automated code reviews on this repo. Configure here.}

codecov · 2026-06-29T01:42:01Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.73%. Comparing base (e5594da) to head (c630bc8).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #1070 +/- ##
==========================================
+ Coverage 89.38% 90.73% +1.35% 
==========================================
Files 89 91 +2 Lines 5179 5970 +791 Branches 663 873 +210 ==========================================
+ Hits 4629 5417 +788 
Misses 386 386 - Partials 164 167 +3

Flag	Coverage Δ
unittests	`90.70% <ø> (+1.32%)`	⬆️

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

☔ View full report in Codecov by Harness.
📢 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.

github-actions · 2026-06-29T01:42:29Z

Pyright Type Completeness

View the full pyright --verifytypes output for this commit

Project (full chainladder package, at this PR's head): 13.5% of exported symbols fully typed (163 / 1209)

	Known	Ambiguous	Unknown	Total
Project (head)	163	107	939	1209

Other symbols referenced but not exported by chainladder: 13

	Known	Ambiguous	Unknown	Total
Other (head)	3	1	9	13

Symbols without documentation:

Functions without docstring: 315
Functions without default param: 0
Classes without docstring: 10

Patch (exported symbols added or changed by this PR): no exported symbol type-completeness changes detected.

henrydingliu · 2026-06-29T02:49:03Z

thank you so much for this!! just one gripe.

genedan · 2026-06-29T01:41:36Z

Summary of Changes

I asked Claude to write this up, because there was no way I was going to draw that tree manually.

Related GitHub Issue(s)

#1004

Additional Context for Reviewers

GitHub-rendered Markdown can be viewed at:

https://github.com/casact/chainladder-python/blob/3fb2ac47ee290b7d3f1de7df3f2ac25b1a806f88/ARCHITECTURE.md

Let me know what you think of the level of jargon in this file, and whether you think an interested contributor would understand it. I had to do a lot of googling of the terms. I expanded acronyms and added clarifying text.

For example a sentence like:

Triangle is assembled from a stack of single-responsibility mixins. Python resolves methods left-to-right across the MRO (method resolution order), so the order in TriangleBase determines which mixin wins on any name collision.

Could be written in plainer English if we expanded it to be a few paragraphs. After googling terms like "single-responsibility" and "MRO", I decided I was mostly satisfied with these explanations, so I didn't replace the jargon.

I passed tests locally for both code (uv run pytest) and documentation changes (uv run jb build docs --builder=custom --custom-builder=doctest)

Note

Low Risk
Documentation-only change with no runtime or API impact.

Overview
Introduces ARCHITECTURE.md at the repo root as onboarding documentation for contributors (issue #1004).

The doc maps the chainladder/ tree (core, development, tails, methods, adjustments, workflow, utils) with short notes on what each module owns. It explains how Triangle is built from mixins via TriangleBase and MRO order, how .loc / .iloc accessors are composed through TriangleSlicer._set_slicers, and documents the TYPE_CHECKING + TriangleProtocol pattern for mixin typing without runtime MRO conflicts. A second section sketches sklearn-style inheritance for development, tail, reserve, adjustment, and workflow estimators.

No application code, tests, or build config are modified—documentation only.

^{Reviewed by Cursor Bugbot for commit c630bc8. Bugbot is set up for automated code reviews on this repo. Configure here.}

codecov · 2026-06-29T01:42:01Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.73%. Comparing base (e5594da) to head (c630bc8).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #1070 +/- ##
==========================================
+ Coverage 89.38% 90.73% +1.35% 
==========================================
Files 89 91 +2 Lines 5179 5970 +791 Branches 663 873 +210 ==========================================
+ Hits 4629 5417 +788 
Misses 386 386 - Partials 164 167 +3

Flag	Coverage Δ
unittests	`90.70% <ø> (+1.32%)`	⬆️

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

☔ View full report in Codecov by Harness.
📢 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.

github-actions · 2026-06-29T01:42:29Z

Pyright Type Completeness

View the full pyright --verifytypes output for this commit

Project (full chainladder package, at this PR's head): 13.5% of exported symbols fully typed (163 / 1209)

	Known	Ambiguous	Unknown	Total
Project (head)	163	107	939	1209

Other symbols referenced but not exported by chainladder: 13

	Known	Ambiguous	Unknown	Total
Other (head)	3	1	9	13

Symbols without documentation:

Functions without docstring: 315
Functions without default param: 0
Classes without docstring: 10

Patch (exported symbols added or changed by this PR): no exported symbol type-completeness changes detected.

henrydingliu · 2026-06-29T02:49:03Z

thank you so much for this!! just one gripe.

genedan · 2026-06-29T01:41:36Z

Summary of Changes

I asked Claude to write this up, because there was no way I was going to draw that tree manually.

Related GitHub Issue(s)

#1004

Additional Context for Reviewers

GitHub-rendered Markdown can be viewed at:

https://github.com/casact/chainladder-python/blob/3fb2ac47ee290b7d3f1de7df3f2ac25b1a806f88/ARCHITECTURE.md

Let me know what you think of the level of jargon in this file, and whether you think an interested contributor would understand it. I had to do a lot of googling of the terms. I expanded acronyms and added clarifying text.

For example a sentence like:

Triangle is assembled from a stack of single-responsibility mixins. Python resolves methods left-to-right across the MRO (method resolution order), so the order in TriangleBase determines which mixin wins on any name collision.

Could be written in plainer English if we expanded it to be a few paragraphs. After googling terms like "single-responsibility" and "MRO", I decided I was mostly satisfied with these explanations, so I didn't replace the jargon.

I passed tests locally for both code (uv run pytest) and documentation changes (uv run jb build docs --builder=custom --custom-builder=doctest)

Note

Low Risk
Documentation-only change with no runtime or API impact.

Overview
Introduces ARCHITECTURE.md at the repo root as onboarding documentation for contributors (issue #1004).

The doc maps the chainladder/ tree (core, development, tails, methods, adjustments, workflow, utils) with short notes on what each module owns. It explains how Triangle is built from mixins via TriangleBase and MRO order, how .loc / .iloc accessors are composed through TriangleSlicer._set_slicers, and documents the TYPE_CHECKING + TriangleProtocol pattern for mixin typing without runtime MRO conflicts. A second section sketches sklearn-style inheritance for development, tail, reserve, adjustment, and workflow estimators.

No application code, tests, or build config are modified—documentation only.

^{Reviewed by Cursor Bugbot for commit c630bc8. Bugbot is set up for automated code reviews on this repo. Configure here.}

codecov · 2026-06-29T01:42:01Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.73%. Comparing base (e5594da) to head (c630bc8).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #1070 +/- ##
==========================================
+ Coverage 89.38% 90.73% +1.35% 
==========================================
Files 89 91 +2 Lines 5179 5970 +791 Branches 663 873 +210 ==========================================
+ Hits 4629 5417 +788 
Misses 386 386 - Partials 164 167 +3

Flag	Coverage Δ
unittests	`90.70% <ø> (+1.32%)`	⬆️

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

☔ View full report in Codecov by Harness.
📢 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.

github-actions · 2026-06-29T01:42:29Z

Pyright Type Completeness

View the full pyright --verifytypes output for this commit

Project (full chainladder package, at this PR's head): 13.5% of exported symbols fully typed (163 / 1209)

	Known	Ambiguous	Unknown	Total
Project (head)	163	107	939	1209

Other symbols referenced but not exported by chainladder: 13

	Known	Ambiguous	Unknown	Total
Other (head)	3	1	9	13

Symbols without documentation:

Functions without docstring: 315
Functions without default param: 0
Classes without docstring: 10

Patch (exported symbols added or changed by this PR): no exported symbol type-completeness changes detected.

henrydingliu · 2026-06-29T02:49:03Z

thank you so much for this!! just one gripe.

genedan · 2026-06-29T01:41:36Z

Summary of Changes

I asked Claude to write this up, because there was no way I was going to draw that tree manually.

Related GitHub Issue(s)

#1004

Additional Context for Reviewers

GitHub-rendered Markdown can be viewed at:

https://github.com/casact/chainladder-python/blob/3fb2ac47ee290b7d3f1de7df3f2ac25b1a806f88/ARCHITECTURE.md

Let me know what you think of the level of jargon in this file, and whether you think an interested contributor would understand it. I had to do a lot of googling of the terms. I expanded acronyms and added clarifying text.

For example a sentence like:

Triangle is assembled from a stack of single-responsibility mixins. Python resolves methods left-to-right across the MRO (method resolution order), so the order in TriangleBase determines which mixin wins on any name collision.

Could be written in plainer English if we expanded it to be a few paragraphs. After googling terms like "single-responsibility" and "MRO", I decided I was mostly satisfied with these explanations, so I didn't replace the jargon.

I passed tests locally for both code (uv run pytest) and documentation changes (uv run jb build docs --builder=custom --custom-builder=doctest)

Note

Low Risk
Documentation-only change with no runtime or API impact.

Overview
Introduces ARCHITECTURE.md at the repo root as onboarding documentation for contributors (issue #1004).

The doc maps the chainladder/ tree (core, development, tails, methods, adjustments, workflow, utils) with short notes on what each module owns. It explains how Triangle is built from mixins via TriangleBase and MRO order, how .loc / .iloc accessors are composed through TriangleSlicer._set_slicers, and documents the TYPE_CHECKING + TriangleProtocol pattern for mixin typing without runtime MRO conflicts. A second section sketches sklearn-style inheritance for development, tail, reserve, adjustment, and workflow estimators.

No application code, tests, or build config are modified—documentation only.

^{Reviewed by Cursor Bugbot for commit c630bc8. Bugbot is set up for automated code reviews on this repo. Configure here.}

codecov · 2026-06-29T01:42:01Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.73%. Comparing base (e5594da) to head (c630bc8).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #1070 +/- ##
==========================================
+ Coverage 89.38% 90.73% +1.35% 
==========================================
Files 89 91 +2 Lines 5179 5970 +791 Branches 663 873 +210 ==========================================
+ Hits 4629 5417 +788 
Misses 386 386 - Partials 164 167 +3

Flag	Coverage Δ
unittests	`90.70% <ø> (+1.32%)`	⬆️

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

☔ View full report in Codecov by Harness.
📢 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.

github-actions · 2026-06-29T01:42:29Z

Pyright Type Completeness

View the full pyright --verifytypes output for this commit

Project (full chainladder package, at this PR's head): 13.5% of exported symbols fully typed (163 / 1209)

	Known	Ambiguous	Unknown	Total
Project (head)	163	107	939	1209

Other symbols referenced but not exported by chainladder: 13

	Known	Ambiguous	Unknown	Total
Other (head)	3	1	9	13

Symbols without documentation:

Functions without docstring: 315
Functions without default param: 0
Classes without docstring: 10

Patch (exported symbols added or changed by this PR): no exported symbol type-completeness changes detected.

henrydingliu · 2026-06-29T02:49:03Z

thank you so much for this!! just one gripe.

DOCS: Add ARCHITECTURE.md.
3fb2ac4

genedan requested review from henrydingliu, jbogaardt and kennethshsu as code owners June 29, 2026 01:41

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md Outdated

genedan added 2 commits June 29, 2026 08:35

Merge branch 'main' into architecture_md
9245188

FIX: Address PR review notes.
c630bc8

henrydingliu approved these changes Jul 1, 2026
View reviewed changes

genedan merged commit 7d512f1 into mainJul 1, 2026
18 checks passed

genedan deleted the architecture_md branch July 15, 2026 13:41

DOCS: Add ARCHITECTURE.md.
3fb2ac4

genedan requested review from henrydingliu, jbogaardt and kennethshsu as code owners June 29, 2026 01:41

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md Outdated

genedan added 2 commits June 29, 2026 08:35

Merge branch 'main' into architecture_md
9245188

FIX: Address PR review notes.
c630bc8

henrydingliu approved these changes Jul 1, 2026
View reviewed changes

genedan merged commit 7d512f1 into mainJul 1, 2026
18 checks passed

genedan deleted the architecture_md branch July 15, 2026 13:41

DOCS: Add ARCHITECTURE.md.
3fb2ac4

genedan requested review from henrydingliu, jbogaardt and kennethshsu as code owners June 29, 2026 01:41

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md Outdated

genedan added 2 commits June 29, 2026 08:35

Merge branch 'main' into architecture_md
9245188

FIX: Address PR review notes.
c630bc8

henrydingliu approved these changes Jul 1, 2026
View reviewed changes

genedan merged commit 7d512f1 into mainJul 1, 2026
18 checks passed

genedan deleted the architecture_md branch July 15, 2026 13:41

DOCS: Add ARCHITECTURE.md.
3fb2ac4

genedan requested review from henrydingliu, jbogaardt and kennethshsu as code owners June 29, 2026 01:41

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md Outdated

genedan added 2 commits June 29, 2026 08:35

Merge branch 'main' into architecture_md
9245188

FIX: Address PR review notes.
c630bc8

henrydingliu approved these changes Jul 1, 2026
View reviewed changes

genedan merged commit 7d512f1 into mainJul 1, 2026
18 checks passed

genedan deleted the architecture_md branch July 15, 2026 13:41

DOCS: Add ARCHITECTURE.md.
3fb2ac4

genedan requested review from henrydingliu, jbogaardt and kennethshsu as code owners June 29, 2026 01:41

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md Outdated

genedan added 2 commits June 29, 2026 08:35

Merge branch 'main' into architecture_md
9245188

FIX: Address PR review notes.
c630bc8

henrydingliu approved these changes Jul 1, 2026
View reviewed changes

genedan merged commit 7d512f1 into mainJul 1, 2026
18 checks passed

genedan deleted the architecture_md branch July 15, 2026 13:41

DOCS: Add ARCHITECTURE.md.
3fb2ac4

genedan requested review from henrydingliu, jbogaardt and kennethshsu as code owners June 29, 2026 01:41

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md Outdated

genedan added 2 commits June 29, 2026 08:35

Merge branch 'main' into architecture_md
9245188

FIX: Address PR review notes.
c630bc8

henrydingliu approved these changes Jul 1, 2026
View reviewed changes

genedan merged commit 7d512f1 into mainJul 1, 2026
18 checks passed

genedan deleted the architecture_md branch July 15, 2026 13:41

DOCS: Add ARCHITECTURE.md.
3fb2ac4

genedan requested review from henrydingliu, jbogaardt and kennethshsu as code owners June 29, 2026 01:41

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md Outdated

genedan added 2 commits June 29, 2026 08:35

Merge branch 'main' into architecture_md
9245188

FIX: Address PR review notes.
c630bc8

henrydingliu approved these changes Jul 1, 2026
View reviewed changes

genedan merged commit 7d512f1 into mainJul 1, 2026
18 checks passed

genedan deleted the architecture_md branch July 15, 2026 13:41

DOCS: Add ARCHITECTURE.md.
3fb2ac4

genedan requested review from henrydingliu, jbogaardt and kennethshsu as code owners June 29, 2026 01:41

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md

henrydingliu reviewed Jun 29, 2026
View reviewed changes

Comment threadARCHITECTURE.md Outdated

genedan added 2 commits June 29, 2026 08:35

Merge branch 'main' into architecture_md
9245188

FIX: Address PR review notes.
c630bc8

henrydingliu approved these changes Jul 1, 2026
View reviewed changes

genedan merged commit 7d512f1 into mainJul 1, 2026
18 checks passed

genedan deleted the architecture_md branch July 15, 2026 13:41

Uh oh!

Conversation

genedan commented Jun 29, 2026• edited by cursor BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of Changes

Related GitHub Issue(s)

Additional Context for Reviewers

Uh oh!

codecovBot commented Jun 29, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actionsBot commented Jun 29, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pyright Type Completeness

Uh oh!

Uh oh!

Uh oh!

henrydingliu commented Jun 29, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

genedan commented Jun 29, 2026• edited by cursor BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of Changes

Related GitHub Issue(s)

Additional Context for Reviewers

Uh oh!

codecovBot commented Jun 29, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actionsBot commented Jun 29, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pyright Type Completeness

Uh oh!

Uh oh!

Uh oh!

henrydingliu commented Jun 29, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

genedan commented Jun 29, 2026• edited by cursor BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of Changes

Related GitHub Issue(s)

Additional Context for Reviewers

Uh oh!

codecovBot commented Jun 29, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actionsBot commented Jun 29, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pyright Type Completeness

Uh oh!

Uh oh!

Uh oh!

henrydingliu commented Jun 29, 2026

Uh oh!

Uh oh!

Reviewers

genedan commented Jun 29, 2026•
edited by cursor Bot
Loading

codecovBot commented Jun 29, 2026•
edited
Loading

github-actionsBot commented Jun 29, 2026•
edited
Loading

genedan commented Jun 29, 2026•
edited by cursor Bot
Loading

codecovBot commented Jun 29, 2026•
edited
Loading

github-actionsBot commented Jun 29, 2026•
edited
Loading

genedan commented Jun 29, 2026•
edited by cursor Bot
Loading

codecovBot commented Jun 29, 2026•
edited
Loading

github-actionsBot commented Jun 29, 2026•
edited
Loading

genedan commented Jun 29, 2026•
edited by cursor Bot
Loading

codecovBot commented Jun 29, 2026•
edited
Loading

github-actionsBot commented Jun 29, 2026•
edited
Loading

genedan commented Jun 29, 2026•
edited by cursor Bot
Loading

codecovBot commented Jun 29, 2026•
edited
Loading