Skip to content
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.

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

Improve Buffer.len() return type docs #86

Open
amunra opened this issue Jan 15, 2025 · 1 comment
Open

Improve Buffer.len() return type docs #86

amunra opened this issue Jan 15, 2025 · 1 comment

Comments

@amunra
Copy link
Collaborator

amunra commented Jan 15, 2025

It's been reported that the len method can be confused to return the row count instead of the byte count.

We should improve the docs to explain that the buffer is not a collection of rows, but a binary buffer.

Additionally, the len method in Rust should use a ByteCount typedef of usize to further clarify its use.

@amunra
Copy link
Collaborator Author

amunra commented Jan 15, 2025

N.B.

We should follow through with similar doc / tidy up for the Python __len__ dunder method and C++ .size() method.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant