Skip to content

DOC: fix PR02 errors in docstrings - pandas.Series.interpolate, pandas.read_hdf, pandas.HDFStore.append #57114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 29, 2024
Merged

DOC: fix PR02 errors in docstrings - pandas.Series.interpolate, pandas.read_hdf, pandas.HDFStore.append #57114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d7a381
Resolve PR02 errors in docstrings: pandas.Series.interpolate, pandas.…
jordan-d-murphy Jan 28, 2024
4be0b8d
Update code_checks.sh
jordan-d-murphy Jan 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.PeriodIndex.strftime\
pandas.Series.clip\
pandas.Series.rename_axis\
pandas.Series.interpolate\
pandas.Series.dt.to_period\
pandas.Series.dt.tz_localize\
pandas.Series.dt.tz_convert\
Expand Down Expand Up @@ -186,8 +185,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.core.groupby.DataFrameGroupBy.hist\
pandas.core.groupby.DataFrameGroupBy.plot\
pandas.core.groupby.SeriesGroupBy.plot\
pandas.read_hdf\
pandas.HDFStore.append\
pandas.core.window.rolling.Rolling.quantile\
pandas.core.window.expanding.Expanding.quantile\
pandas.api.extensions.ExtensionArray.argsort # There should be no backslash in the final line, please keep this comment in the last ignored function
Expand Down
10 changes: 5 additions & 5 deletions pandas/io/pytables.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ def read_hdf(
A list of Term (or convertible) objects.
start : int, optional
Row number to start selection.
stop : int, optional
stop : int, optional
Row number to stop selection.
columns : list, optional
A list of columns names to return.
Expand Down Expand Up @@ -1269,18 +1269,18 @@ def append(
subsets of the data.
index : bool, default True
Write DataFrame index as a column.
append : bool, default True
append : bool, default True
Append the input data to the existing.
data_columns : list of columns, or True, default None
List of columns to create as indexed data columns for on-disk
queries, or True to use all columns. By default only the axes
of the object are indexed. See `here
<https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#query-via-data-columns>`__.
min_itemsize : dict of columns that specify minimum str sizes
nan_rep : str to use as str nan representation
chunksize : size to chunk the writing
nan_rep : str to use as str nan representation
chunksize : size to chunk the writing
expectedrows : expected TOTAL row size of this table
encoding : default None, provide an encoding for str
encoding : default None, provide an encoding for str
dropna : bool, default False, optional
Do not write an ALL nan row to the store settable
by the option 'io.hdf.dropna_table'.
Expand Down