DOC: Fixing EX01 - Added examples (pandas-dev#54210)

* Examples pandas.test, read_feather...

* add skip doctest

* Correct code_checks.sh

---------

Co-authored-by: Marco Edward Gorelli <[email protected]>

Author: DeaMariaLeon

ci/code_checks.sh

@@ -73,13 +73,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         pandas.errors.PyperclipWindowsException \
         pandas.errors.UnsortedIndexError \
         pandas.errors.UnsupportedFunctionCall \
-        pandas.test \
         pandas.NaT \
-        pandas.read_feather \
-        pandas.read_orc \
-        pandas.read_sas \
-        pandas.read_spss \
-        pandas.read_sql_query \
         pandas.io.stata.StataReader.data_label \
         pandas.io.stata.StataReader.value_labels \
         pandas.io.stata.StataReader.variable_labels \

pandas/io/feather_format.py

@@ -103,6 +103,10 @@ def read_feather(
     Returns
     -------
     type of object stored in file
+
+    Examples
+    --------
+    >>> df = pd.read_feather("path/to/file.feather")  # doctest: +SKIP
     """
     import_optional_dependency("pyarrow")
     from pyarrow import feather

pandas/io/orc.py

@@ -95,6 +95,10 @@ def read_orc(
     a ``pyarrow.fs`` filesystem will be attempted to read the file. You can also pass a
     pyarrow or fsspec filesystem object into the filesystem keyword to override this
     behavior.
+
+    Examples
+    --------
+    >>> result = pd.read_orc("example_pa.orc")  # doctest: +SKIP
     """
     # we require a newer version of pyarrow than we support for parquet
 

pandas/io/sas/sasreader.py

@@ -126,6 +126,10 @@ def read_sas(
     -------
     DataFrame if iterator=False and chunksize=None, else SAS7BDATReader
     or XportReader
+
+    Examples
+    --------
+    >>> df = pd.read_sas("sas_data.sas7bdat")  # doctest: +SKIP
     """
     if format is None:
         buffer_error_msg = (

pandas/io/spss.py

@@ -50,6 +50,10 @@ def read_spss(
     Returns
     -------
     DataFrame
+
+    Examples
+    --------
+    >>> df = pd.read_spss("spss_data.sav")  # doctest: +SKIP
     """
     pyreadstat = import_optional_dependency("pyreadstat")
     check_dtype_backend(dtype_backend)

pandas/io/sql.py

@@ -468,6 +468,13 @@ def read_sql_query(
     -----
     Any datetime values with time zone information parsed via the `parse_dates`
     parameter will be converted to UTC.
+
+    Examples
+    --------
+    >>> from sqlalchemy import create_engine  # doctest: +SKIP
+    >>> engine = create_engine("sqlite:///database.db")  # doctest: +SKIP
+    >>> with engine.connect() as conn, conn.begin():  # doctest: +SKIP
+    ...     data = pd.read_sql_table("data", conn)  # doctest: +SKIP
     """
 
     check_dtype_backend(dtype_backend)

pandas/util/_tester.py

@@ -25,6 +25,11 @@ def test(extra_args: list[str] | None = None, run_doctests: bool = False) -> Non
         Whether to only run the Python and Cython doctests. If you would like to run
         both doctests/regular tests, just append "--doctest-modules"/"--doctest-cython"
         to extra_args.
+
+    Examples
+    --------
+    >>> pd.test()  # doctest: +SKIP
+    running: pytest...
     """
     pytest = import_optional_dependency("pytest")
     import_optional_dependency("hypothesis")