Skip to content

v4.29.0: Documentation Enhancements

Choose a tag to compare

@dgunning dgunning released this 20 Nov 16:12
· 1841 commits to main since this release

v4.29.0 - Documentation Enhancements Release

Release Date: 2025-11-20
Theme: Comprehensive documentation improvements for enterprise users and advanced use cases

📚 Major Documentation Additions

XBRL Standardization Customization Guide

  • 2,408-line comprehensive guide for customizing XBRL concept mappings
  • Real-world examples from Tesla, Microsoft, and Berkshire Hathaway
  • Documents 200+ ambiguous XBRL tags requiring context-aware resolution
  • CSV workflow for Excel-based mapping management
  • Validation techniques and quality assurance methods
  • Target Audience: Financial analysts managing large company datasets
  • Location: docs/advanced/customizing-standardization.md
  • Addresses: Issue #494

Enterprise Configuration Guide

  • Custom SEC mirror/proxy configuration
  • Rate limiting and SSL verification settings
  • Performance optimization techniques
  • Troubleshooting guide for enterprise deployments
  • Target Audience: Enterprise users, academic institutions
  • Location: docs/configuration.md and enhanced docs/advanced-guide.md

✨ User Experience Improvements

Smart API Warnings for Filing Access

  • Intelligent warnings guide users between get_filings() and get_current_filings()
  • Detects when users try to access today's filings from quarterly indexes
  • Eliminates common confusion around dual-API architecture
  • Impact: Reduces user frustration with stale data
  • Implementation: 153 lines of logic, 17 new tests

page_size=None Support

  • Pythonic page_size=None parameter for fetching all current filings
  • Simplifies "get all today's filings" use case
  • Backward compatible with existing code

📦 Installation

pip install --upgrade edgartools

🔗 Links

🙏 Acknowledgments

Special thanks to @mpreiss9 for sharing detailed methodology on handling 200+ companies with XBRL standardization, which inspired our comprehensive documentation and future enhancement roadmap.


Test Coverage: 2,228 tests passing
Python Support: 3.8, 3.9, 3.10, 3.11, 3.12