gdtest-ref-inherited-explicit

Tests explicit inherited member documentation via reference config.

Reference config listing inherited methods (validate, reset) explicitly in the members list of AdvancedProcessor. The child class page should document all three listed methods even though two are inherited.

Source files

📁 gdtest_ref_inherited_explicit/

📄 __init__.py

"""Package testing explicit inherited member documentation."""

__version__ = "0.1.0"
__all__ = ["BaseProcessor", "AdvancedProcessor"]


class BaseProcessor:
    """
    Base processor with core functionality.

    Parameters
    ----------
    name : str
        Processor name.
    """

    def __init__(self, name: str):
        self.name = name

    def validate(self, data: dict) -> bool:
        """
        Validate input data.

        Parameters
        ----------
        data : dict
            Data to validate.

        Returns
        -------
        bool
            True if valid.
        """
        return bool(data)

    def reset(self) -> None:
        """
        Reset the processor state.

        Returns
        -------
        None
        """
        pass


class AdvancedProcessor(BaseProcessor):
    """
    Advanced processor that inherits validate and reset from Base.

    Parameters
    ----------
    name : str
        Processor name.
    mode : str
        Processing mode.
    """

    def __init__(self, name: str, mode: str = "fast"):
        super().__init__(name)
        self.mode = mode

    def process(self, data: dict) -> dict:
        """
        Process data using the configured mode.

        Parameters
        ----------
        data : dict
            Data to process.

        Returns
        -------
        dict
            Processed results.
        """
        if self.validate(data):
            return {"result": data, "mode": self.mode}
        return {}

📄 README.md

# gdtest-ref-inherited-explicit

Tests explicit inherited member documentation via reference config.

📄 great-docs.yml

reference:
  - title: Core
    desc: Core classes
    contents:
      - BaseProcessor
      - name: AdvancedProcessor
        members:
          - process
          - validate
          - reset