Skip to content

Commit 1ab1f6f

Browse files
apacheGH-34037: [Python][Docs] Fix Table.drop docstring (apache#34038)
It throws errors in the CI, while I was working on other docstrings: ``` pyarrow.lib.Table.drop -> pyarrow.lib.Table.drop(self, columns) PR01: Parameters {'columns'} not documented pyarrow.lib.Table.drop -> pyarrow.lib.Table.drop(self, columns) PR01: Parameters {'columns'} not documented pyarrow.lib.Table.drop -> pyarrow.lib.Table.drop(self, columns) PR01: Parameters {'columns'} not documented Total number of docstring violations: 3 ``` ### Rationale for this change ### What changes are included in this PR? ### Are these changes tested? ### Are there any user-facing changes? * Closes: apache#34037 Lead-authored-by: "Fokko Driesprong <[email protected]>" Co-authored-by: Joris Van den Bossche <[email protected]> Co-authored-by: Fokko Driesprong <[email protected]> Signed-off-by: Joris Van den Bossche <[email protected]>
1 parent d1e5cb5 commit 1ab1f6f

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

python/pyarrow/table.pxi

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4726,7 +4726,21 @@ cdef class Table(_PandasConvertible):
47264726
return table
47274727

47284728
def drop(self, columns):
4729-
"""Alias of Table.drop_columns, but kept for backwards compatibility."""
4729+
"""
4730+
Drop one or more columns and return a new table.
4731+
4732+
Alias of Table.drop_columns, but kept for backwards compatibility.
4733+
4734+
Parameters
4735+
----------
4736+
columns : str or list[str]
4737+
Field name(s) referencing existing column(s).
4738+
4739+
Returns
4740+
-------
4741+
Table
4742+
New table without the column(s).
4743+
"""
47304744
return self.drop_columns(columns)
47314745

47324746
def group_by(self, keys):

0 commit comments

Comments
 (0)