Skip to content

Add docstrings to SmartDataframe class and __init__ method #1804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ArslanSaleem merged 1 commit into from
Sep 30, 2025
+15 −0
Merged

Add docstrings to SmartDataframe class and __init__ method #1804

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions pandasai/smart_dataframe/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@


class SmartDataframe:
"""
A wrapper class for pandas DataFrame that integrates with PandasAI features.
Provides additional metadata and configuration options, and will be deprecated in favor of df.chat().
"""

_table_name: str
_table_description: str
_custom_head: str = None
Expand All @@ -27,6 +32,16 @@ def __init__(
custom_head: pd.DataFrame = None,
config: Config = None,
):
"""
Initialize a SmartDataframe instance.

Args:
df (pd.DataFrame): The pandas DataFrame to wrap.
name (str, optional): Name of the table.
description (str, optional): Description of the table.
custom_head (pd.DataFrame, optional): Custom head DataFrame for display.
config (Config, optional): PandasAI configuration object.
"""
warnings.warn(
"\n"
+ "*" * 80
Expand Down