-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Closed
Description
Describe the bug
The docstring for the add_dataframe_asset method in great_expectations/datasource/fluent/spark_datasource.py references a dataframe argument, but the function signature does not include a dataframe parameter. This creates confusion about how the method should be used.
To Reproduce
- View the
add_dataframe_assetmethod definition. - Observe that the docstring includes:
Args: name: The name of the DataFrame asset. This can be any arbitrary string. dataframe: The Spark Dataframe containing the data for this DataFrame data asset. batch_metadata: An arbitrary user defined dictionary with string keys which will get inherited by any batches created from the asset.
- The actual function signature is:
def add_dataframe_asset( self, name: str, batch_metadata: Optional[BatchMetadata] = None, ) -> DataFrameAsset:
- There is no
dataframeparameter.
Expected behavior
The docstring should accurately reflect the function signature, or the function should accept a dataframe argument if that is the intended usage.
Environment (please complete the following information):
- Operating System: N/A (documentation issue)
- Great Expectations Version: [please fill in, if relevant]
- Data Source: Spark
- Cloud environment: N/A
Additional context
This appears to be a documentation oversight. Please clarify the intended API for adding a DataFrame asset and update the docstring or method signature accordingly.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels