Skip to content

Commit 292a993

Browse files
authored
Docstring fixes for PR06 errors (#31838)
1 parent f27d70f commit 292a993

File tree

6 files changed

+10
-9
lines changed

6 files changed

+10
-9
lines changed

pandas/core/arrays/interval.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1175,7 +1175,7 @@ def __arrow_array__(self, type=None):
11751175
11761176
Parameters
11771177
----------
1178-
na_tuple : boolean, default True
1178+
na_tuple : bool, default True
11791179
Returns NA as a tuple if True, ``(nan, nan)``, or just as the NA
11801180
value itself if False, ``nan``.
11811181

pandas/core/groupby/groupby.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -2336,7 +2336,8 @@ def shift(self, periods=1, freq=None, axis=0, fill_value=None):
23362336
----------
23372337
periods : int, default 1
23382338
Number of periods to shift.
2339-
freq : frequency string
2339+
freq : str, optional
2340+
Frequency string
23402341
axis : axis to shift, default 0
23412342
fill_value : optional
23422343

pandas/core/indexes/multi.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1598,7 +1598,7 @@ def to_frame(self, index=True, name=None):
15981598
index : bool, default True
15991599
Set the index of the returned DataFrame as the original MultiIndex.
16001600
1601-
name : list / sequence of strings, optional
1601+
name : list / sequence of str, optional
16021602
The passed names should substitute index level names.
16031603
16041604
Returns

pandas/io/pytables.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -1139,11 +1139,11 @@ def append(
11391139
queries, or True to use all columns. By default only the axes
11401140
of the object are indexed. See `here
11411141
<https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#query-via-data-columns>`__.
1142-
min_itemsize : dict of columns that specify minimum string sizes
1143-
nan_rep : string to use as string nan representation
1142+
min_itemsize : dict of columns that specify minimum str sizes
1143+
nan_rep : str to use as str nan representation
11441144
chunksize : size to chunk the writing
11451145
expectedrows : expected TOTAL row size of this table
1146-
encoding : default None, provide an encoding for strings
1146+
encoding : default None, provide an encoding for str
11471147
dropna : bool, default False
11481148
Do not write an ALL nan row to the store settable
11491149
by the option 'io.hdf.dropna_table'.

pandas/io/spss.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ def read_spss(
2020
2121
Parameters
2222
----------
23-
path : string or Path
23+
path : str or Path
2424
File path.
2525
usecols : list-like, optional
2626
Return a subset of the columns. If None, return all columns.

pandas/io/sql.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ def read_sql_query(
284284
Using SQLAlchemy makes it possible to use any DB supported by that
285285
library.
286286
If a DBAPI2 object, only sqlite3 is supported.
287-
index_col : str or list of strings, optional, default: None
287+
index_col : str or list of str, optional, default: None
288288
Column(s) to set as index(MultiIndex).
289289
coerce_float : bool, default True
290290
Attempts to convert values of non-string, non-numeric objects (like
@@ -364,7 +364,7 @@ def read_sql(
364364
library. If a DBAPI2 object, only sqlite3 is supported. The user is responsible
365365
for engine disposal and connection closure for the SQLAlchemy connectable. See
366366
`here <https://docs.sqlalchemy.org/en/13/core/connections.html>`_
367-
index_col : str or list of strings, optional, default: None
367+
index_col : str or list of str, optional, default: None
368368
Column(s) to set as index(MultiIndex).
369369
coerce_float : bool, default True
370370
Attempts to convert values of non-string, non-numeric objects (like

0 commit comments

Comments
 (0)