Doc: Fix RT03 errors for read_orc, read_sas, read_spss, read_stata (#…

…57801) Fix RT03 errors for read_orc, read_sas, read_spss, read_stata
pandas-dev · Mar 11, 2024 · ba64039 · ba64039
1 parent a78a22f
commit ba64039
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 7 deletions.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -840,10 +840,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         pandas.plotting.parallel_coordinates\
         pandas.plotting.radviz\
         pandas.plotting.table\
-        pandas.read_orc\
-        pandas.read_sas\
-        pandas.read_spss\
-        pandas.read_stata\
         pandas.set_eng_float_format # There should be no backslash in the final line, please keep this comment in the last ignored function
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 

diff --git a/pandas/io/orc.py b/pandas/io/orc.py
@@ -83,6 +83,7 @@ def read_orc(
     Returns
     -------
     DataFrame
+        DataFrame based on the ORC file.
 
     Notes
     -----

diff --git a/pandas/io/sas/sasreader.py b/pandas/io/sas/sasreader.py
@@ -119,8 +119,9 @@ def read_sas(
 
     Returns
     -------
-    DataFrame if iterator=False and chunksize=None, else SAS7BDATReader
-    or XportReader
+    DataFrame, SAS7BDATReader, or XportReader
+        DataFrame if iterator=False and chunksize=None, else SAS7BDATReader
+        or XportReader, file format is inferred from file extension.
 
     Examples
     --------

diff --git a/pandas/io/spss.py b/pandas/io/spss.py
@@ -50,6 +50,7 @@ def read_spss(
     Returns
     -------
     DataFrame
+        DataFrame based on the SPSS file.
 
     Examples
     --------

diff --git a/pandas/io/stata.py b/pandas/io/stata.py
@@ -161,7 +161,8 @@
 
 Returns
 -------
-DataFrame or pandas.api.typing.StataReader
+DataFrame, pandas.api.typing.StataReader
+    If iterator or chunksize, returns StataReader, else DataFrame.
 
 See Also
 --------
-Original file line number
+Diff line change
@@ Expand Up / @@ -83,6 +83,7 @@ def read_orc( @@
         Returns
         -------
         DataFrame
+            DataFrame based on the ORC file.
         Notes
         -----
@@ Expand Down @@