Method check

tools/check_documentation.py:46–70

(cls)

    @classmethod
    def check(cls):
        cls.subclasses |= cls.discover_subclasses(cls.BASE_SEARCH_CLASS.__subclasses__())
        cls.exceptions |= cls.discover_subclasses(cls.exceptions)
        success = True
        for subclass in cls.subclasses:
            if subclass in cls.exceptions:
                continue
            if not cls.HAS_ATTRIBUTE_TABLE.search(subclass.__doc__):
                print(f"Subclass {subclass.__module__}.{subclass.__name__} is missing a table of common attributes.")
                success = False
            for method_name in dir(subclass):
                if method_name in cls.METHOD_EXCEPTIONS:
                    continue
                method = getattr(subclass, method_name)
                if (callable(method) or isinstance(method, cachedproperty)) and not method_name.startswith("_"):
                    if isinstance(method, cachedproperty):
                        method = method.func
                    if not cls.HAS_CODE_BLOCK.search(method.__doc__):
                        print(
                            "Method"
                            f" {subclass.__module__}.{subclass.__name__}.{method.__name__}"
                            " is missing code examples."
                        )
                        success = False
        return success


def main():