How does the SingleElementCheck work?

[alphanome]

And should it return True here instead?

https://github.com/alphanome-ai/sec-parser/blob/b1b9213b1e2b01da6c1acf820d462e05270a75b3/sec_parser/processing_steps/individual_semantic_element_extractor/single_element_checks/xbrl_tag_check.py#L22

[Elijas]

Code Context

Let's take a look at the docstring for AbstractSingleElementCheck

    def contains_single_element(self, element: AbstractSemanticElement) -> bool | None:
        """
        Designed to work as series of subsequent checks.
        - Returning None means that the check is inconclusive, and the next check should be performed.
        - Returning True means that no further checks are necessary, and the HTML element will be
        later be able to be converted into a semantic element without any splits.
        - Returning False means that the HTML element will be split into multiple semantic elements
        of type NotYetClassifiedElement.
        """

And the checks available:

    def get_default_single_element_checks(self) -> list[AbstractSingleElementCheck]:
        return [
            XbrlTagCheck(),
            ImageCheck(),
            # TableCheck is last because it is potentially computationally expensive
            TableCheck(),
        ]

Source data context

<ix:something> tags usually hold multiple elements inside them and the contents inside them usually won't be able to be classified as a single element.

Current solution

Currently, we preemptively just split all elements inside the <ix:something> each into a new NotYetClassified element, by returning "contains_single_element=False" (contains multiple elements, therefore it needs to be split).

Future solution

Ideally, we would check more thoroughly for the insides of a <ix:something>, as the current solution is just a quick fix.

[INF800]

Makes sense, thanks! Please review PR alphanome-ai/sec-parser#38.