DOC: Fix ES01 for pandas.DataFrame (#64034)

Author: tuhinsharma121

ci/code_checks.sh

@@ -123,16 +123,12 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.Series.is_unique ES01" \
         -i "pandas.Series.is_monotonic_increasing ES01" \
         -i "pandas.Series.is_monotonic_decreasing ES01" \
-        -i "pandas.Series.droplevel ES01" \
         -i "pandas.Series.drop_duplicates ES01" \
         -i "pandas.Series.rename_axis ES01" \
         -i "pandas.Series.mask ES01" \
-        -i "pandas.Series.ffill ES01" \
-        -i "pandas.Series.fillna ES01" \
         -i "pandas.Series.unstack ES01" \
         -i "pandas.Series.explode ES01" \
         -i "pandas.Series.compare ES01" \
-        -i "pandas.Series.tz_convert ES01" \
         -i "pandas.Series.at_time ES01" \
         -i "pandas.Series.cat ES01" \
         -i "pandas.Series.sparse ES01" \
@@ -149,7 +145,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.Series.to_csv ES01" \
         -i "pandas.Series.to_dict ES01" \
         -i "pandas.Series.to_frame ES01" \
-        -i "pandas.Series.to_xarray ES01" \
         -i "pandas.Series.to_string ES01" \
         -i "pandas.Series.to_markdown ES01" \
         -i "pandas.testing.assert_series_equal ES01" \
@@ -484,21 +479,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.DataFrame.round ES01" \
         -i "pandas.DataFrame.value_counts ES01" \
         -i "pandas.DataFrame.at_time ES01" \
-        -i "pandas.DataFrame.rename_axis ES01" \
-        -i "pandas.DataFrame.ffill ES01" \
-        -i "pandas.DataFrame.fillna ES01" \
-        -i "pandas.DataFrame.droplevel ES01" \
-        -i "pandas.DataFrame.sort_values ES01" \
-        -i "pandas.DataFrame.explode ES01" \
-        -i "pandas.DataFrame.to_xarray ES01" \
-        -i "pandas.DataFrame.T ES01" \
-        -i "pandas.DataFrame.compare ES01" \
-        -i "pandas.DataFrame.tz_convert ES01" \
-        -i "pandas.DataFrame.sparse.density ES01" \
-        -i "pandas.DataFrame.sparse.from_spmatrix ES01" \
-        -i "pandas.DataFrame.sparse.to_coo ES01" \
-        -i "pandas.DataFrame.sparse.to_dense ES01" \
-        -i "pandas.DataFrame.to_string ES01" \
         -i "pandas.DataFrame.to_markdown ES01" # no backslash in the last line
 
     RET=$(($RET + $?)) ; echo $MSG "DONE"

pandas/core/arrays/sparse/accessor.py

@@ -310,6 +310,9 @@ def from_spmatrix(cls, data, index=None, columns=None) -> DataFrame:
         """
         Create a new DataFrame from a scipy sparse matrix.
 
+        This method converts a scipy sparse matrix into a pandas DataFrame
+        with sparse array columns for memory efficiency.
+
         Parameters
         ----------
         data : scipy.sparse.spmatrix
@@ -369,6 +372,9 @@ def to_dense(self) -> DataFrame:
         """
         Convert a DataFrame with sparse values to dense.
 
+        This method converts all SparseArray columns in the DataFrame to
+        regular NumPy arrays.
+
         Returns
         -------
         DataFrame
@@ -397,6 +403,9 @@ def to_coo(self) -> spmatrix:
         """
         Return the contents of the frame as a sparse SciPy COO matrix.
 
+        This method converts the DataFrame to a scipy COO (Coordinate) sparse
+        matrix format for interoperability with scipy.sparse routines.
+
         Returns
         -------
         scipy.sparse.spmatrix
@@ -450,6 +459,9 @@ def density(self) -> float:
         """
         Ratio of non-sparse points to total (dense) data points.
 
+        This property returns the proportion of the data that is not sparse
+        (i.e., not equal to the fill value), as a value between 0 and 1.
+
         See Also
         --------
         DataFrame.sparse.from_spmatrix : Create a new DataFrame from a

pandas/core/frame.py

@@ -1076,6 +1076,9 @@ def to_string(
         """
         Render a DataFrame to a console-friendly tabular output.
 
+        This method converts the DataFrame to a string representation suitable
+        for printing or writing to a file.
+
         Parameters
         ----------
         buf : str, Path or StringIO-like, optional, default None
@@ -4121,6 +4124,9 @@ def T(self) -> DataFrame:
         """
         The transpose of the DataFrame.
 
+        This property returns a DataFrame with rows and columns interchanged,
+        reflecting the data across the main diagonal.
+
         Returns
         -------
         DataFrame
@@ -7987,6 +7993,9 @@ def sort_values(
         """
         Sort by the values along either axis.
 
+        This method sorts the DataFrame by the values in one or more columns
+        or by index/column labels.
+
         Parameters
         ----------
         by : str or list of str
@@ -11808,6 +11817,9 @@ def compare(
         """
         Compare to another DataFrame and show the differences.
 
+        This method compares two DataFrames element-wise and returns a DataFrame
+        highlighting the differences.
+
         Parameters
         ----------
         other : DataFrame
@@ -13207,6 +13219,9 @@ def explode(
         """
         Transform each element of a list-like to a row, replicating index values.
 
+        This method is useful for expanding nested data structures like lists
+        into separate rows while maintaining the relationship with other columns.
+
         Parameters
         ----------
         column : IndexLabel

pandas/core/generic.py

@@ -770,6 +770,9 @@ def droplevel(self, level: IndexLabel, axis: Axis = 0) -> Self:
         """
         Return Series/DataFrame with requested index / column level(s) removed.
 
+        This method is useful for simplifying a MultiIndex by removing one or
+        more levels.
+
         Parameters
         ----------
         level : int, str, or list-like
@@ -1120,6 +1123,9 @@ def rename_axis(
         """
         Set the name of the axis for the index or columns.
 
+        This method is useful for labeling the axes in a MultiIndex or for
+        providing descriptive names to axes.
+
         Parameters
         ----------
         mapper : scalar, list-like, optional
@@ -3235,6 +3241,9 @@ def to_xarray(self):
         """
         Return an xarray object from the pandas object.
 
+        This method converts a pandas object to an xarray object, which is
+        useful for working with labeled multi-dimensional data.
+
         Returns
         -------
         xarray.DataArray or xarray.Dataset
@@ -6942,6 +6951,8 @@ def fillna(
         """
         Fill NA/NaN values with `value`.
 
+        This method replaces missing values with a specified value.
+
         Parameters
         ----------
         value : scalar, dict, Series, or DataFrame
@@ -7181,6 +7192,9 @@ def ffill(
         """
         Fill NA/NaN values by propagating the last valid observation to next valid.
 
+        This method fills missing values using forward fill, where the last
+        valid observation is propagated forward to fill the gaps.
+
         Parameters
         ----------
         axis : {0 or 'index'} for Series, {0 or 'index', 1 or 'columns'} for DataFrame
@@ -10875,6 +10889,9 @@ def tz_convert(
         """
         Convert tz-aware axis to target time zone.
 
+        This method converts the timezone of a datetime-based index from one
+        timezone to another.
+
         Parameters
         ----------
         tz : str or tzinfo object or None