Skip to content

[Protocol] Make Column.get_buffers() docstring more explicit #272

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Protocol] Make Column.get_buffers() docstring more explicit #272

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions protocol/dataframe_protocol.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,12 @@ def get_buffers(self) -> ColumnBuffers:
"""
Return a dictionary containing the underlying buffers.

Each buffer has its own dtype which can be distinct from the
column's dtype. For example, a column with the ``STRING`` dtype
could be represented by two buffers: a "data" buffer with
dtype ``INT`` and bit width 8, and an "offsets" buffer with
dtype ``INT`` and bit width 32.

The returned dictionary has the following contents:

- "data": a two-element tuple whose first element is a buffer
Expand Down