Skip to content

feat: docs restructure, show_versions, pyright CI, remove 1e-10 zero guards#6

Merged
quantbai merged 2 commits intodevfrom
feature/docs-and-zero-guard-removal
Mar 24, 2026
Merged

feat: docs restructure, show_versions, pyright CI, remove 1e-10 zero guards#6
quantbai merged 2 commits intodevfrom
feature/docs-and-zero-guard-removal

Conversation

@quantbai
Copy link
Copy Markdown
Owner

@quantbai quantbai commented Mar 24, 2026

Summary

  • Add show_versions() for bug report diagnostics
  • Add community templates (issue, PR, CODE_OF_CONDUCT, SECURITY)
  • Restructure docs: CLAUDE.md (AI memo), CONTRIBUTING.md (human guide)
  • Add pyright static type checking to CI
  • [NUMERICAL] Remove arbitrary 1e-10 zero guards (23 instances)
  • Replace interval-based panel skeleton with union-based skeleton

Change Type

  • Bug fix (corrects incorrect behavior)
  • New feature (new operator or functionality)
  • Refactor (no behavior change)
  • Numerical change (alters factor computation results) [BREAKING]

Numerical Impact

Category Before After
divide, inverse abs(denom) < 1e-10 → null No guard. Inf → null via Factor
zscore, scale, etc. < 1e-10 → 0.0 == 0 → 0.0 (exact zero)
ts_regression, etc. < 1e-10 → 0.0 == 0 → 0.0 (exact zero)

Testing

  • Added or updated tests
  • All tests pass (pytest tests/ -v) -- 141 passed
  • Lint passes (ruff check elvers/)
  • Type check passes (pyright elvers/) -- 0 errors

quantbai and others added 2 commits March 25, 2026 03:40
@quantbai @claude
feat(ci): add pyright static type checking
6a9c5df 
- Fix 4 pyright errors in factor.py (hash annotation, eq/ne override, dead code)
- Add pyright to CI pipeline and dev dependencies
- Remove _resolve_other (dead code after _binary refactor)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@quantbai @claude
docs: add pyright to all checklists and update changelog for 0.4.0
665a253 
- PR template: add pyright check item
- README Development section: add pyright command
- CONTRIBUTING: add pyright to verify, dev cycle, and pre-PR checklist
- CHANGELOG [Unreleased]: full list of additions and changes since 0.3.0

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@quantbai quantbai merged commit 598b78d into dev Mar 24, 2026
4 checks passed
@quantbai quantbai deleted the feature/docs-and-zero-guard-removal branch March 24, 2026 19:49
quantbai added a commit that referenced this pull request Mar 25, 2026
@quantbai @claude
feat: column-based Factor architecture, 12-step pipeline, pyright CI (#6
96e9471 
)

- Column-based Factor: stores column name + Panel ref (zero intermediate DataFrames)
- Column-level memoization: _add_col skips if column exists
- Panel._add_col with NaN/Inf -> null sanitization
- Pyright static type checking in CI (0 errors)
- 12-step pipeline architecture scaffolded in docs
- Detailed next-steps roadmap in CLAUDE.md for session continuity
- All 141 tests passing

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@quantbai