This is an automated email from the ASF dual-hosted git repository.
jorisvandenbossche pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new 1ab1f6f159 GH-34037: [Python][Docs] Fix Table.drop docstring (#34038)
1ab1f6f159 is described below
commit 1ab1f6f159ebf4df1216f28288207a357bbb4017
Author: Fokko Driesprong <[email protected]>
AuthorDate: Tue Feb 7 09:34:25 2023 +0100
GH-34037: [Python][Docs] Fix Table.drop docstring (#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: #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]>
---
python/pyarrow/table.pxi | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/python/pyarrow/table.pxi b/python/pyarrow/table.pxi
index c5c8924b42..cd12236f53 100644
--- a/python/pyarrow/table.pxi
+++ b/python/pyarrow/table.pxi
@@ -4726,7 +4726,21 @@ cdef class Table(_PandasConvertible):
return table
def drop(self, columns):
- """Alias of Table.drop_columns, but kept for backwards
compatibility."""
+ """
+ Drop one or more columns and return a new table.
+
+ Alias of Table.drop_columns, but kept for backwards compatibility.
+
+ Parameters
+ ----------
+ columns : str or list[str]
+ Field name(s) referencing existing column(s).
+
+ Returns
+ -------
+ Table
+ New table without the column(s).
+ """
return self.drop_columns(columns)
def group_by(self, keys):
