From 34567f5ec0c62b5f0c762c314149e6cd078bd244 Mon Sep 17 00:00:00 2001 From: Tyler White <50381805+IndexSeek@users.noreply.github.com> Date: Mon, 18 Nov 2024 22:50:57 +0000 Subject: [PATCH] docs(api): deprecate to_array in favor of as_scalar in docstring --- ibis/expr/types/relations.py | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/ibis/expr/types/relations.py b/ibis/expr/types/relations.py index c7b6619639a8..1c321797dcb6 100644 --- a/ibis/expr/types/relations.py +++ b/ibis/expr/types/relations.py @@ -1812,13 +1812,8 @@ def difference(self, table: Table, *rest: Table, distinct: bool = True) -> Table @deprecated(as_of="9.0", instead="use table.as_scalar() instead") def to_array(self) -> ir.Column: - """View a single column table as an array. + """Deprecated - use `as_scalar` instead.""" - Returns - ------- - Value - A single column view of a table - """ schema = self.schema() if len(schema) != 1: raise com.ExpressionError(