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.

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

Jump to bottom

BinViewChunkedBuilder has incorrect docs #17277

Closed
kevinli1993 opened this issue Jun 28, 2024 · 1 comment
Closed

BinViewChunkedBuilder has incorrect docs #17277

kevinli1993 opened this issue Jun 28, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation rust Related to Rust Polars

Comments

@kevinli1993
Copy link

kevinli1993 commented Jun 28, 2024 •
edited
Loading

Description

According to this page, BinViewChunkedBuilder::new takes the arguments (capacity and bytes_capacity).

Arguments
 - capacity - Number of string elements in the final array.
 - bytes_capacity - Number of bytes needed to store the string values.

However, the function signature only has name and capacity.

Screenshot:

image

Link

https://docs.pola.rs/api/rust/dev/polars/chunked_array/builder/struct.BinViewChunkedBuilder.html
@kevinli1993 kevinli1993 added the documentation Improvements or additions to documentation label Jun 28, 2024
@stinodego stinodego added the rust Related to Rust Polars label Jul 1, 2024
@krasnobaev
Copy link
Contributor

The bytes_capacity argument was originally used in the StringChunkedBuilder constructor. However, since StringChunkedBuilder is now type-aliased to BinViewChunkedBuilder, this parameter is no longer required.

This change was introduced in #13748 and particularly here.

I will submit a PR for this shortly.

krasnobaev added a commit to krasnobaev/polars that referenced this issue Aug 28, 2024
@krasnobaev
docs(rust): Fix BinViewChunkedBuilder arguments pola-rs#17277
a11b2a5
@krasnobaev krasnobaev mentioned this issue Aug 28, 2024
Merged
ritchie46 pushed a commit that referenced this issue Aug 28, 2024
@krasnobaev
docs(rust): Fix BinViewChunkedBuilder arguments (#17277) (#18439)
b2550a0
r-brink pushed a commit to r-brink/polars that referenced this issue Aug 29, 2024
@krasnobaev @r-brink
docs(rust): Fix BinViewChunkedBuilder arguments (pola-rs#17277) (pola…
c72bfa7 
…-rs#18439)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation rust Related to Rust Polars
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@ritchie46 @stinodego @krasnobaev @kevinli1993