Skip to content

Refreshes CLAUDE.md to match the current code - #60

Merged
dylanjm merged 1 commit into
mainfrom
docs-claude-md-refresh
Oct 27, 2026
Merged

dylanjm merged 1 commit into
mainfrom
docs-claude-md-refresh

Conversation

@j-bryan

@j-bryan j-bryan commented Oct 27, 2026

Copy link
Copy Markdown
Collaborator

Brings CLAUDE.md (and AGENTS.md, which is a symlink to it) in line with the code. Documentation only.

  • Python version: 3.11+, not 3.13+ (requires-python = ">=3.11", ruff py311). The code uses TypeAlias and module-level TypeVars, not PEP 695 syntax.
  • Package layout: dcaf/core/ no longer exists. The section now describes streams/, finance/, tax/, metrics/, shared/ and project/, and utils.py is now shared/time.py.
  • Root exports: dcaf/__init__.py exports only the project-level API. The primitives are imported from the subpackages.
  • CashFlow:
    • tags/CashFlowTags is replaced by pro_forma_category/tax_treatment (the ProFormaCategory and TaxTreatment enums).
    • group_by_tag() is replaced by group_by_pro_forma_category() and group_by_tax_treatment().
  • Generation: the half-open period_start/period_end fields are documented.
  • New entries: EnergyProject and ProjectAnalysis.
  • Immutability: the value types are frozen, while streams and groups are plain dataclasses whose operations return new instances.
  • Day counts: the three options are listed. The PTC module path is now tax/incentives.py.
  • Date-interval list: removed the nonexistent BaseStream.date_range.
  • Ruff commands: ruff check . and ruff format ., matching pre-commit.
  • Typo: "Guideliens" is now "Guidelines".

Result changes

None.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@dylanjm dylanjm left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great updated to Claude.md

@dylanjm
dylanjm merged commit 3464871 into main Oct 27, 2026
1 check passed
@dylanjm
dylanjm deleted the docs-claude-md-refresh branch October 27, 2026 20:20
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