Skip to content

docs: sync README and website with current feature set#72

Merged
maskedsyntax merged 1 commit intomainfrom
docs/sync-feature-set
Mar 16, 2026
Merged

docs: sync README and website with current feature set#72
maskedsyntax merged 1 commit intomainfrom
docs/sync-feature-set

Conversation

@maskedsyntax
Copy link
Member

Summary

Audited the README and website docs against the current codebase and brought both fully up to date. Fixes incorrect check names, adds missing checks and CLI flags, and documents the configuration file feature that was previously undocumented.

- Add missing checks: datetime_future_dates, datetime_gaps, datetime_monotonicity,
  normality, variance_homogeneity, low_mutual_information
- Fix incorrect check names in website docs (many_zeros → high_zero_counts,
  target_leakage → target_leakage_patterns, missing_values → dataset_missingness)
- Document --config flag across all CLI commands (scan, details, report)
- Add config file loading section to Python API docs
- Add dedicated Configuration section to website with YAML/TOML/JSON examples
- Add --comparison flag to scan/details CLI reference on website
- Expand Available Checks from ~12 to all 30 checks across both docs
@vercel
Copy link

vercel bot commented Mar 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
hashprep Ready Ready Preview, Comment Mar 16, 2026 0:38am

@maskedsyntax maskedsyntax merged commit 8551654 into main Mar 16, 2026
6 checks passed
@maskedsyntax maskedsyntax deleted the docs/sync-feature-set branch March 16, 2026 12:44
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.

1 participant