Skip to content

Commit

Permalink
docs(api): minor docs fixes and updates (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
kennedykori authored Jul 15, 2024
1 parent 0b2cb3a commit 857b43b
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions src/sghi/etl/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)

Expand Down

0 comments on commit 857b43b

Please sign in to comment.