Searched text is highlighted in the results

[BaraVaq]

Feature Category

• New API functionality
• Performance improvement
• Developer experience improvement
• Documentation enhancement
• Tool/utility addition

Problem Statement

When running:

filings[0].search('repurchase', regex=True)

The result shows numbered text sections, but where in these sections the word appear is unclear.

P.S. when not using regex location indexes are wrong.

Who would benefit from this feature?

• Beginner Python users working with SEC filings
• Financial analysts and researchers
• Advanced developers building financial applications
• Data scientists working with financial datasets

Proposed Solution

Make the found words highlighted with color for faster finding.
Additionally it would be nice to have not only a number of the section in these blocks but pages from the .html()

Describe alternatives you've considered
Searching in a browser.

Use Case Example

How would you use this feature?

filings[0].search('repurchase', regex=True)

Implementation Considerations

Complexity Level:

• Simple (minor API addition)
• Moderate (new functionality with existing patterns)
• Complex (significant architectural changes)

Backwards Compatibility:

• This feature maintains backwards compatibility
• This feature might break existing code (please explain below)
• Unsure about compatibility impact

Additional Context

Add any other context, screenshots, or examples about the feature request here.

Related Issues/Features:

---

Feature requests are evaluated based on EdgarTools' core principles: Simple yet powerful, accurate financials, beginner-friendly, and joyful UX.

[dgunning]

Thanks for the suggestion. Highlighting search matches in the rich output is a natural fit for our UX goals.

Classification: P3 feature, tracked as edgartools-gnzy.

Three items here:

1. Match highlighting — Good idea. The rich library supports [bold] and [red] markup, so highlighting matched terms in the search results output is straightforward.

2. Page references from .html() — Worth exploring, though HTML pages don't have a stable "page number" concept (they're continuous scroll). We could potentially show the section/item reference (e.g., "Item 1A - Risk Factors") instead, which would be more useful for navigation.

3. Wrong location indexes without regex — This sounds like it could be a separate bug. The non-regex path uses BM25 search which has a different indexing model than the regex path. Could you share an example showing the incorrect indexes? That would help us reproduce.

This is queued as a UX enhancement for a future release.

[BaraVaq]

from edgar import Company

company = Company("MSFT")
filings = company.get_filings(form=["10-K", "10-Q"], filing_date="2020-01-01:")

Here at location 0 delivers different result: