diff --git a/src/sghi/etl/core.py b/src/sghi/etl/core.py index 9b1e594..6b76581 100644 --- a/src/sghi/etl/core.py +++ b/src/sghi/etl/core.py @@ -108,6 +108,11 @@ def __call__(self, raw_data: _RDT) -> _PDT: def apply(self, raw_data: _RDT) -> _PDT: """Transform raw data into processed, clean data and return it. + .. versionadded:: 1.1.0 + + This replaces :meth:`~sghi.etl.core.Processor.process` which is + deprecated and will be removed in a future version. + :param raw_data: The unprocessed data drawn from a `Source`. :return: The processed, cleaned data that is ready for further @@ -119,16 +124,21 @@ def apply(self, raw_data: _RDT) -> _PDT: def process(self, raw_data: _RDT) -> _PDT: """Transform raw data into processed, clean data and return it. - .. warning:: + .. deprecated:: 1.1.0 This method is deprecated and will be removed in a future - version. Clients of this class should use the :meth:`apply` - method instead, which this method delegates to. + version. Clients of this class should use the + :meth:`~sghi.etl.core.Processor.apply` method instead, which this + method delegates to. :param raw_data: The unprocessed data drawn from a `Source`. :return: The processed, cleaned data that is ready for further consumption downstream. + + .. seealso:: + + :meth:`~sghi.etl.core.Processor.apply` """ return self.apply(raw_data)