Merge pull request #31 from cparmet/fix-docstring-argname

Fix argument name in docstrings
cparmet · Jun 27, 2024 · 221c5eb · 221c5eb
2 parents 9f62062 + f98d76f
commit 221c5eb
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/pandas_checks/DataFrameChecks.py b/pandas_checks/DataFrameChecks.py
@@ -581,7 +581,7 @@ def assert_type(
         """Tests whether Dataframe or subset of columns meets type assumption. Optionally raises an exception. Does not modify the DataFrame itself.
 
         Args:
-            type: The required variable type
+            dtype: The required variable type
             subset: Optional, which column or columns to check the condition against. `
             pass_message: Message to display if the condition passes.
             fail_message: Message to display if the condition fails.

diff --git a/pandas_checks/SeriesChecks.py b/pandas_checks/SeriesChecks.py
@@ -545,7 +545,7 @@ def assert_type(
         """Tests whether Series meets type assumption. Optionally raises an exception. Does not modify the Series itself.
 
         Args:
-            type: The required variable type
+            dtype: The required variable type
 
             pass_message: Message to display if the condition passes.
             fail_message: Message to display if the condition fails.