From a512b5c7fe3999d3c0f6f27c0da774fdad898ccb Mon Sep 17 00:00:00 2001 From: HowToSD Date: Thu, 20 Feb 2025 00:20:50 -0800 Subject: [PATCH] Updated docstring for Pandas Rename node to clarify the node parameters. --- docs/reference/pandas_rename.md | 8 ++++++-- modules/pandas_wrapper/pandas_rename.py | 7 ++++++- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/reference/pandas_rename.md b/docs/reference/pandas_rename.md index 70f119f..b03f9cf 100644 --- a/docs/reference/pandas_rename.md +++ b/docs/reference/pandas_rename.md @@ -1,13 +1,17 @@ # Pandas Rename Renames an index (row label) or a column label. +Note below node parameter description is inaccurate due to a reference generator's bug: +* axis takes columns or index, not DataFrame. +* Both current_label and new_label take a String. + ## Input | Name | Data type | |---|---| | dataframe | DataFrame | -| axis | DataFrame | +| axis | | | current_label | String | -| new_label | | +| new_label | String | ## Output | Data type | diff --git a/modules/pandas_wrapper/pandas_rename.py b/modules/pandas_wrapper/pandas_rename.py index bfe2fdc..4034181 100644 --- a/modules/pandas_wrapper/pandas_rename.py +++ b/modules/pandas_wrapper/pandas_rename.py @@ -6,9 +6,14 @@ class PandasRename: """ Renames an index (row label) or a column label. + Note below node parameter description is inaccurate due to a reference generator's bug: + * axis takes columns or index, not DataFrame. + * Both current_label and new_label take a String. + category: Transformation """ - + # TODO: Fix parameter description in node reference doc. + @classmethod def INPUT_TYPES(cls) -> Dict[str, Any]: """